Skip to main content
List Disposition Groups
curl --request GET \
  --url https://api.agents.timepay.ai/api/v1/dispositions/groups/list \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": [
    {
      "id": "BQhJQMcijOPZEVhXgova",
      "name": "Call Back",
      "description": "Call customer again if given dispositions are found",
      "dispositions": [
        "qmJFQyVugpOAPjREQeEF",
        "sorlyJWVWKvqzfPFFeuT"
      ],
      "dispositionDetails": [
        {
          "id": "qmJFQyVugpOAPjREQeEF",
          "name": "No Answer",
          "description": "Customer did not pick up",
          "priority": 100
        },
        {
          "id": "sorlyJWVWKvqzfPFFeuT",
          "name": "Busy",
          "description": "Line was busy",
          "priority": 110
        }
      ],
      "createdAt": "2024-11-19T12:32:10",
      "updatedAt": "2024-11-19T12:32:10"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 5,
    "totalPages": 1
  }
}

​
Overview

Retrieve a paginated list of all disposition groups 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
​
expand
boolean
default:"false"
If true, includes full disposition details for each group

​
Response

​
success
boolean
Indicates if the request was successful
​
data
array
Array of disposition group objects
​
pagination
object
Pagination information
{
  "success": true,
  "data": [
    {
      "id": "BQhJQMcijOPZEVhXgova",
      "name": "Call Back",
      "description": "Call customer again if given dispositions are found",
      "dispositions": [
        "qmJFQyVugpOAPjREQeEF",
        "sorlyJWVWKvqzfPFFeuT"
      ],
      "dispositionDetails": [
        {
          "id": "qmJFQyVugpOAPjREQeEF",
          "name": "No Answer",
          "description": "Customer did not pick up",
          "priority": 100
        },
        {
          "id": "sorlyJWVWKvqzfPFFeuT",
          "name": "Busy",
          "description": "Line was busy",
          "priority": 110
        }
      ],
      "createdAt": "2024-11-19T12:32:10",
      "updatedAt": "2024-11-19T12:32:10"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 5,
    "totalPages": 1
  }
}

​
Error Codes

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

​
Using the Expand Parameter

When expand=true, each group includes a dispositionDetails array with full information about each disposition in the group. This is useful when you need to display disposition names and properties without making additional API calls.
Using expand=true may increase response time for groups with many dispositions. Use it only when you need the full disposition details.