List Disposition Groups
curl --request GET \
--url https://api.agents.timepay.ai/api/v1/dispositions/groups/list \
--header 'Authorization: <authorization>'import requests
url = "https://api.agents.timepay.ai/api/v1/dispositions/groups/list"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.agents.timepay.ai/api/v1/dispositions/groups/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.agents.timepay.ai/api/v1/dispositions/groups/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.agents.timepay.ai/api/v1/dispositions/groups/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.agents.timepay.ai/api/v1/dispositions/groups/list")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agents.timepay.ai/api/v1/dispositions/groups/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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
}
}
{
"success": true,
"data": [
{
"id": "BQhJQMcijOPZEVhXgova",
"name": "Call Back",
"description": "Call customer again if given dispositions are found",
"dispositions": [
"qmJFQyVugpOAPjREQeEF",
"sorlyJWVWKvqzfPFFeuT"
],
"createdAt": "2024-11-19T12:32:10",
"updatedAt": "2024-11-19T12:32:10"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 5,
"totalPages": 1
}
}
{
"success": false,
"error": "Unauthorized",
"message": "Missing or invalid authorization header"
}
{
"success": false,
"error": "Forbidden",
"message": "You don't have the required permission to perform this action"
}
{
"success": false,
"error": "InternalServerError",
"message": "An unexpected error occurred"
}
Dispositions Group
List Disposition Groups
Retrieve a paginated list of all disposition groups
List Disposition Groups
curl --request GET \
--url https://api.agents.timepay.ai/api/v1/dispositions/groups/list \
--header 'Authorization: <authorization>'import requests
url = "https://api.agents.timepay.ai/api/v1/dispositions/groups/list"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.agents.timepay.ai/api/v1/dispositions/groups/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.agents.timepay.ai/api/v1/dispositions/groups/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.agents.timepay.ai/api/v1/dispositions/groups/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.agents.timepay.ai/api/v1/dispositions/groups/list")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agents.timepay.ai/api/v1/dispositions/groups/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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
}
}
{
"success": true,
"data": [
{
"id": "BQhJQMcijOPZEVhXgova",
"name": "Call Back",
"description": "Call customer again if given dispositions are found",
"dispositions": [
"qmJFQyVugpOAPjREQeEF",
"sorlyJWVWKvqzfPFFeuT"
],
"createdAt": "2024-11-19T12:32:10",
"updatedAt": "2024-11-19T12:32:10"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 5,
"totalPages": 1
}
}
{
"success": false,
"error": "Unauthorized",
"message": "Missing or invalid authorization header"
}
{
"success": false,
"error": "Forbidden",
"message": "You don't have the required permission to perform this action"
}
{
"success": false,
"error": "InternalServerError",
"message": "An unexpected error occurred"
}
Overview
Retrieve a paginated list of all disposition groups in your organization with optional filtering.Headers
string
required
Bearer token for authentication (e.g.,
Bearer <your_token>).Query Parameters
integer
default:"1"
Page number for pagination
string
Search term to filter by name and description
boolean
default:"false"
If
true, includes full disposition details for each groupResponse
boolean
Indicates if the request was successful
array
Array of disposition group objects
object
{
"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
}
}
{
"success": true,
"data": [
{
"id": "BQhJQMcijOPZEVhXgova",
"name": "Call Back",
"description": "Call customer again if given dispositions are found",
"dispositions": [
"qmJFQyVugpOAPjREQeEF",
"sorlyJWVWKvqzfPFFeuT"
],
"createdAt": "2024-11-19T12:32:10",
"updatedAt": "2024-11-19T12:32:10"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 5,
"totalPages": 1
}
}
{
"success": false,
"error": "Unauthorized",
"message": "Missing or invalid authorization header"
}
{
"success": false,
"error": "Forbidden",
"message": "You don't have the required permission to perform this action"
}
{
"success": false,
"error": "InternalServerError",
"message": "An unexpected error occurred"
}
Error Codes
| Status | Description |
|---|---|
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Missing required permissions |
500 | Internal server error |
Using the Expand Parameter
Whenexpand=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.