Skip to main content
GET
Get a message and its delivery state

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Path Parameters

messageId
string
required

Response

Workspace-scoped message.

Every key is always present; optional fields are null when unset.

id
string
required
Example:

"msg_x6q5vl75f5d53m7oet2k4r5w6a"

externalId
string | null
required
Example:

"msg_123"

conversationId
string
required
Example:

"conv_x6q5vl75f5d53m7oet2k4r5w6a"

sender
enum<string>
required
Available options:
customer,
agent,
ai,
system
body
string
required
Example:

"Hi, is this villa available for yearly rental?"

channel
string
required
Example:

"whatsapp"

attachments
object[]
required
metadata
object
required
internal
boolean
required
createdAt
string<date-time>
required