Skip to main content
GET
/
api
/
call_queue_entries
GET /api/call_queue_entries
curl --request GET \
  --url https://api.sippet.ai/api/call_queue_entries \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "call_uuid": "<string>",
        "queue_name": "<string>",
        "abandoned_at": "<unknown>",
        "agent_name": "<string>",
        "answered_at": "<unknown>",
        "caller_id_name": "<string>",
        "caller_id_number": "<string>",
        "completed_at": "<unknown>",
        "state": "waiting",
        "wait_started_at": "<unknown>"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "<string>",
            "type": "<string>",
            "meta": {}
          }
        }
      }
    }
  ],
  "included": [
    "<unknown>"
  ],
  "meta": {}
}

Authorizations

​
Authorization
string
header
required

JWT for bearer authentication

Query Parameters

​
filter
object

Filters the query to results with attributes matching the given filter object Filters the query to results matching the given filter object

Example:
{}
​
sort
string

Sort order to apply to the results

Pattern: ^(id|-id|\+\+id|--id|call_uuid|-call_uuid|\+\+call_uuid|--call_uuid|queue_name|-queue_name|\+\+queue_name|--queue_name|caller_id_number|-caller_id_number|\+\+caller_id_number|--caller_id_number|caller_id_name|-caller_id_name|\+\+caller_id_name|--caller_id_name|state|-state|\+\+state|--state|agent_name|-agent_name|\+\+agent_name|--agent_name|wait_started_at|-wait_started_at|\+\+wait_started_at|--wait_started_at|answered_at|-answered_at|\+\+answered_at|--answered_at|completed_at|-completed_at|\+\+completed_at|--completed_at|abandoned_at|-abandoned_at|\+\+abandoned_at|--abandoned_at)(,(id|-id|\+\+id|--id|call_uuid|-call_uuid|\+\+call_uuid|--call_uuid|queue_name|-queue_name|\+\+queue_name|--queue_name|caller_id_number|-caller_id_number|\+\+caller_id_number|--caller_id_number|caller_id_name|-caller_id_name|\+\+caller_id_name|--caller_id_name|state|-state|\+\+state|--state|agent_name|-agent_name|\+\+agent_name|--agent_name|wait_started_at|-wait_started_at|\+\+wait_started_at|--wait_started_at|answered_at|-answered_at|\+\+answered_at|--answered_at|completed_at|-completed_at|\+\+completed_at|--completed_at|abandoned_at|-abandoned_at|\+\+abandoned_at|--abandoned_at))*$
​
page
object

Paginates the response with the limit and offset or keyset pagination.

Example:
{ "limit": 25 }
​
include
string

Relationship paths to include in the response

Pattern: ^()(,())*$
​
fields
object

Limits the response fields to only those listed for each type

Example:
{
  "CallQueueEntry": "id,call_uuid,queue_name,caller_id_number,caller_id_name,state,agent_name,wait_started_at,answered_at,completed_at,abandoned_at"
}

Response

Success

​
data
object[]

An array of resource objects representing a CallQueueEntry

​
included
any[]
​
meta
object