Get Work Message

GET

/work/messages/{message_id}

• Production
• QA

One message, if this credential may read the conversation carrying it. With include_record_context=true, an agent’s message also carries the custom records it names that this key may read; the message is otherwise unchanged.

Authorizations

• BearerAuth

Parameters

Path Parameters

message_id

required

Message id

string

Message id

Query Parameters

include_record_context

Also return the custom records an agent’s message names that this key may read

boolean

Also return the custom records an agent’s message names that this key may read

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

One stored Work message.

object

author

Any of:

object

object

key

additional properties

any

null

null

channel

Any of:

string

string

null

null

createdAt

Any of:

string

string

null

null

document

Any of:

object

object

key

additional properties

any

null

null

id

Any of:

string

string

null

null

record_context

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

record_context_unavailable

Any of:

integer

integer

null

null

text

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string