Skip to Content
API access is available to organizations with a signed BAA. Request API access →
API referenceRetrieve a patient message

Retrieve a patient message

GET/patient-messages/{messageId}

Returns one message in a patient conversation, with its delivery status. Use it to check whether a text reached the patient.

Scope
messages.read

Path parameters

messageIdUUIDRequired

ID of the message.

Returns

Returns 200 OK with the Message object.

Errors

Failed requests return application/problem+json problem details. The errors specific to this endpoint:

StatusCodeMeaning
400invalid_requestThe request is malformed, such as invalid JSON.
401invalid_tokenThe API key or access token is missing, expired, or revoked.
403insufficient_scopeThe credential doesn’t have the scope this endpoint needs.
404not_foundThe resource doesn’t exist, or isn’t visible to this credential.
429rate_limitedToo many requests. Retry after Retry-After seconds.
Last updated on