Skip to main content
List Dispositions
curl --request GET \
  --url https://api.agents.timepay.ai/api/v1/dispositions \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": [
    {
      "id": "NiciJNJoGytGUGiyhqgK",
      "name": "Pay in Coming Days/Weeks",
      "description": "Mark if customer says they will pay next day or after few days.",
      "priority": 0,
      "createdAt": "2025-02-06T09:02:03",
      "updatedAt": "2025-02-09T10:30:20"
    },
    {
      "id": "qmJFQyVugpOAPjREQeEF",
      "name": "No Answer",
      "description": "Customer did not pick up the call",
      "priority": 100,
      "createdAt": "2025-02-05T14:20:00",
      "updatedAt": "2025-02-05T14:20:00"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 15,
    "totalPages": 1
  }
}

​
Overview

Retrieve a paginated list of all dispositions in your organization with optional filtering.

​
Headers

​
Authorization
string
required
Bearer token for authentication (e.g., Bearer <your_token>).

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination
​
search
string
Search term to filter by name and description

​
Response

​
success
boolean
Indicates if the request was successful
​
data
array
Array of disposition objects
​
pagination
object
Pagination information
{
  "success": true,
  "data": [
    {
      "id": "NiciJNJoGytGUGiyhqgK",
      "name": "Pay in Coming Days/Weeks",
      "description": "Mark if customer says they will pay next day or after few days.",
      "priority": 0,
      "createdAt": "2025-02-06T09:02:03",
      "updatedAt": "2025-02-09T10:30:20"
    },
    {
      "id": "qmJFQyVugpOAPjREQeEF",
      "name": "No Answer",
      "description": "Customer did not pick up the call",
      "priority": 100,
      "createdAt": "2025-02-05T14:20:00",
      "updatedAt": "2025-02-05T14:20:00"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 15,
    "totalPages": 1
  }
}

​
Error Codes

StatusDescription
401Unauthorized - Invalid or missing API key
403Forbidden - Missing required permissions
500Internal server error