Skip to main content
GET
List the mail threads with provider contacts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "intervention": Include the intervention the thread is attached to (null for other kinds).
  • "contact": Include the provider contact the thread is with (null for a thread opened by a mail from an unreferenced sender).
  • "last-message": Adds lastMessage: the most recent message of the thread.
  • "actions-info": Adds actions { canBeReplied, canBeClosed, canBeReopened }.
Available options:
intervention,
contact,
last-message,
actions-info
orderBy
object[]
whereIds
string<uuid>[]

Filter by one or more conversation ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

Case-insensitive partial match on the subject, the recipient address, or the body of any message in the thread.

Maximum string length: 200
Example:

"lobby"

whereKind
string[]

Filter by what the thread is about.

Example:
whereStatus
string[]

Filter by thread status - only open threads accept messages.

Example:
whereInterventionIds
string<uuid>[]

Filter by the intervention the thread is attached to.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereContactIds
string<uuid>[]

Filter by the provider contact the thread is with.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereUpdatedAt
object

Filter by last activity date.

Example:

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required