Sign in

v1

latestOpenAPI 3.0.02026-07-263365159.1 KB

get/api/v1/external/agents/{casetype_id}/cases

Path parameters

casetype_idstring required

The unique identifier of the case type. You can obtain this value from the List Agents endpoint.

Query parameters

limitinteger

The number of cases to return per page. Accepts values between 0 and 100. Defaults to 20 if not specified.

offsetinteger

The number of records to skip before starting to return results. Use this in combination with limit to paginate through the case list.

sort_by'created_date.asc' | 'created_date.desc' | 'modified_date.asc' | 'modified_date.desc'

The field and direction to sort results by. Defaults to created_date.desc (newest cases first).

stage_idstring[]

One or more stage IDs to filter cases by. Pass multiple values to filter by several stages

assigned_tostring[]

One or more user IDs to filter cases by assigned user. Pass multiple values to include cases assigned to any of the specified users.

workflow_statestring[]

One or more workflow states to filter cases by. Pass multiple values to include cases in any of the specified states.

created_date_fromstring

The start of the creation date range to filter by. Format: DD/MM/YYYY.

created_date_tostring

The end of the creation date range to filter by. Format: DD/MM/YYYY.

modified_date_fromstring

The start of the last-modified date range to filter by. Format: DD/MM/YYYY.

modified_date_tostring

The end of the last-modified date range to filter by. Format: DD/MM/YYYY.

Headers

apikeystring

API key used for authentication. You can find your API key in your account settings.

Response

Success.