Inbox

List inbox threads

GET
/orgs/{organizationId}/inbox

Lists omnichannel inbox conversation threads for the organization.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

Query Parameters

page?integer
Range-9007199254740991 <= value <= 9007199254740991
limit?integer
Range-9007199254740991 <= value <= 9007199254740991
sortBy?string
Value in"id""channel""status""participantExternalId""participantPhone""participantEmail""participantDisplayName""participantCustomFields""participantAvatarS3Folder""participantAvatarS3Key""participantUserAgent""participantIpAddress""participantLocale""participantTracingData""participantLastSeenAt""participantCurrentPageUrl""externalThreadId""customerId""contactId""lastMessageAt""lastMessageDirection""lastMessagePreview""hasUnread""staffTypingExpiresAt""participantTypingExpiresAt""participantUnreadFollowupEmailSentAt""pinnedAt""aiAssistantMode""aiAssistantPausedUntil""createdAt""updatedAt"
sortDir?string
Value in"asc""desc"
include?|array<>|string
externalThreadId?string|array<string>|null
customerId?string|array<string>|null
contactId?string|array<string>|null
channel?|array<>|
status?|array<>|
lastMessageDirection?|array<>|
aiAssistantMode?|array<>|
hasUnread?boolean|string|number|null
participantLastSeenAt?|null
lastMessageAt?|null
staffTypingExpiresAt?|null
participantTypingExpiresAt?|null
participantUnreadFollowupEmailSentAt?|null
pinnedAt?|null
aiAssistantPausedUntil?|null
createdAt?|null
updatedAt?|null
participantExternalId?string|array<string>|
participantPhone?string|array<string>|
participantEmail?string|array<string>|
participantDisplayName?string|array<string>|
participantAvatarS3Folder?string|array<string>|
participantAvatarS3Key?string|array<string>|
participantUserAgent?string|array<string>|
participantIpAddress?string|array<string>|
participantLocale?string|array<string>|
participantCurrentPageUrl?string|array<string>|
lastMessagePreview?string|array<string>|
participantCustomFields?
participantTracingData?
hasEmailReplyTokens?boolean|string|number|null
hasNoEmailReplyTokens?boolean|string|number|null
hasMessages?boolean|string|number|null
hasNoMessages?boolean|string|number|null
hasEvents?boolean|string|number|null
hasNoEvents?boolean|string|number|null
hasAiHandoffs?boolean|string|number|null
hasNoAiHandoffs?boolean|string|number|null
hasTags?boolean|string|number|null
hasNoTags?boolean|string|number|null
hasTasks?boolean|string|number|null
hasNoTasks?boolean|string|number|null
emailReplyTokenId?string|array<string>|
messageId?string|array<string>|
eventId?string|array<string>|
aiHandoffId?string|array<string>|
tagId?array<string>|
taskId?string|array<string>|
hasCustomer?boolean|string|number|null
hasNoCustomer?boolean|string|number|null
hasContact?boolean|string|number|null
hasNoContact?boolean|string|number|null
search?string

Response Body

OK

application/json
  1. response
curl -X GET 'https://api.tillor.eu/orgs/string/inbox'
null