Skip to content

Get all message threads

POST
/api/connector/v1/messageThreads/getAll

Get all message threads that you have created, filtered by time interval and/or specific message thread IDs. Note this operation uses Pagination and supports Portfolio Access Tokens.

MessageThreadFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

Array<string>
nullable >= 1 items <= 1000 items
MessageThreadIds

Unique identifiers of Message threads. Required if no other filter is provided.

Array<string>
nullable >= 1 items <= 1000 items
CreatedUtc
TimeFilterInterval
object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
UpdatedUtc
TimeFilterInterval
object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
],
"CreatedUtc": {
"StartUtc": "2022-03-03T00:00:00Z",
"EndUtc": "2022-03-14T00:00:00Z"
},
"Limitation": {
"Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7",
"Count": 10
}
}

OK

MessageThreadResult
object
MessageThreads
required

The filtered message threads.

Array<object>
Message thread
object
Id
required

Unique identifier of the message thread.

string format: uuid
OriginalSender
required

The sender of the original message in the thread.

string
>= 1 characters
Subject
required

Subject of the message thread.

string
>= 1 characters
CreatedUtc
required

Creation date and time of the message thread in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the message thread in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
IsResolved
boolean
Cursor

Unique identifier of the last and hence oldest message thread returned. This can be used in Limitation in a subsequent request to fetch the next batch of older message threads.

string format: uuid
nullable
Example
{
"MessageThreads": [
{
"Id": "7f9325f6-ef44-4911-89a8-ae51010a5aa4",
"OriginalSender": "John Doe",
"Subject": "Example subject",
"CreatedUtc": "2022-03-07T16:09:45Z",
"UpdatedUtc": "2022-03-07T16:09:45Z"
}
],
"Cursor": "7f9325f6-ef44-4911-89a8-ae51010a5aa4"
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable