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

Retrieve a conversation

Your BloomText team turns this on for your account. Book a call and we’ll set it up with you.Request access
GET/me/conversations/{conversationId}

Returns one of the connected person’s own conversations, with their unread count.

Credentials
OAuth access token only
Scope
messages.read

Path parameters

conversationIdUUIDRequired

ID of the conversation.

Returns

Returns 200 OK with the Conversation 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 is missing or malformed, or isn’t a BloomText key.
401key_revokedThe API key was revoked.
401key_expiredThe API key’s expiry has passed.
403insufficient_scopeThe key doesn’t have the scope this endpoint needs.
403oauth_requiredAPI keys can’t use this endpoint. It needs OAuth.
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