List Dispatches
Retrieves a list of dispatches with filtering and pagination.
Retrieves a list of dispatches, with optional filters and pagination.
Query Parameters
The maximum number of dispatches to return. Defaults to 100.
The number of dispatches to skip. Defaults to 0.
A search term to filter dispatches by name.
Filter dispatches by status.
Filter dispatches by agent ID.
Filter dispatches by CRM scenario ID.
Filter dispatches by CRM step ID.
The start date to filter dispatches by scheduledAt.
The end date to filter dispatches by scheduledAt.
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Number of records to skip for pagination.
Maximum number of records to return.
Search term for dispatch name.
Filter by dispatch status.
Filter by Agent ID.
Filter by CRM Scenario ID.
Filter by CRM Step ID.
Filter dispatches scheduled on or after this date.
Filter dispatches scheduled on or before this date.
Response
Was this page helpful?