Messaging Inbox

POST

/api/v1/workspaces/{workspaceId}/messaging/inbox/threads/search

Scope inbox:read

Search and list inbox threads. Results are paged.

Pfad

workspaceIdPflicht

string

Workspace that owns the resource.

Request

application/json · MessagingInboxThreadSearchRequestDto

page

integer (int32)

Page number, starting at 1.

pageSize

integer (int32)

Number of items per page.

unreadOnly

boolean

Whether unread only is set.

sentOnly

boolean

Whether sent only is set.

senderIdentityId

string (uuid)

Identifier of the sender identity.

folder

MessagingInboxFolderDto

customFolderId

string (uuid)

Identifier of the custom folder.

labelIds

string (uuid)[]

Identifiers of the label.

assignedMemberId

string (uuid)

Identifier of the assigned member.

assignedToMe

boolean

Whether assigned to me is set.

unassigned

boolean

Whether unassigned is set.

query

string

Query.

sort

MessagingInboxThreadSortDto

Antworten

200MessagingInboxThreadListItemDtoListPagedResultThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

results

MessagingInboxThreadListItemDto[]

total

integer (int32)

page

integer (int32)

pageSize

integer (int32)

400ApiProblemThe request is invalid.

401ApiProblemThe private app token is missing or invalid.

403ApiProblemThe token is missing the required scope, or this action is not allowed.

404ApiProblemThe workspace or resource was not found.

defaultApiProblemError response.