https://api-us.engagor.com/{account_id}/inbox/cases

Description

Returns cases from the Inbox together with the mentions linked to them (for a certain filter).

Required Access Token Scope

accounts_read

Parameters

Param Description Required Default Value
filter A filter query string. No
date_from Date range start. Filters on the `date.published` field of the case. ISO 8601 formatted date, defaults to 28 days ago. No
date_to Date range end. Filters on the `date.published` field of the case. ISO 8601 formatted date, defaults to now. No
topic_ids Comma separated list of topic ids to search in. If empty: default inbox selection for user. No
page_token Paging parameter. (The amount of cases you can page back is limited to a total of 10000 cases. Adjust `date_from` & `date_to` to be able to get messages outside that limit.) No
limit Amount of case conversations to return (default 20, min 0, max 100). No
(int) 20
sort How to sort the cases. The value of the sort parameter should be one of the following: "dateadd:desc" (Newest First), "dateadd:asc" (Oldest First), "followers:desc" (Followers), "timestamps.action_reply_first:desc" (First response time), "timestamps.action_reply_first_in_bh:desc" (First Response Time (during BH)), "timestamps.action_status_last:desc" (Resolve time), "timestamps.action_last_date:desc" (Most Recently Updated), "timestamps.action_last_date:asc" (Least Recently Updated), "priority:desc" (Highest Priority First), "priority:asc" (Lowest Priority First), "__random__" (Random), "timestamps.action_first:desc" (First action time), "timestamps.action_last:desc" (Last Action Time) No

Result

paged_list of case_conversation items.

Examples

Fetch cases with the linked mentions

Fetch cases with a certain tag