Allo

Find thread

Finds the discussion thread attached to a conversation item. Returns zero or one thread — each item has at most one thread.

GET/v2/api/threads

Behavior

Looks up the thread attached to a conversation item. Pass the item's type as entity_type (CALL, TEXT_MESSAGE, or CONVERSATION_NOTE) and its ID as entity_id (cll-*, msg-*, or not-*).

Since each item has at most one thread, data contains either zero or one thread. An empty data array means the item exists but has no thread yet — create one with POST /v2/api/threads.

Errors

StatusCodeWhen
400INVALID_THREAD_ENTITY_TYPEentity_type is not one of CALL, TEXT_MESSAGE, CONVERSATION_NOTE
404CONVERSATION_ITEM_NOT_FOUNDNo conversation item with this entity_id

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Query parameters

entity_typeenum<string>required

Type of the conversation item

CALLTEXT_MESSAGECONVERSATION_NOTE

entity_idstringrequired

ID of the conversation item (cll-*, msg-*, or not-*)

Responses

200The item's thread, or an empty list if none exists
dataobject[]
10 fields
idstring

Thread ID (cth-*)

entity_typeenum<string>

Type of the conversation item the thread is attached to.

CALLTEXT_MESSAGECONVERSATION_NOTE

entity_idstring

ID of the conversation item (cll-*, msg-*, or not-*).

contact_numberstring

The contact's phone number (E.164).

resolvedboolean
resolved_atstring<date-time> | null
resolved_byobject

Author of a note or comment.

2 fields
idstring
namestring | null
comment_countinteger
created_atstring<date-time>
commentsobject[]
6 fields
idstring

Comment ID (thc-*)

contentstring

Comment text, with mentions inline as @[Name](usr-...).

userobject

Author of a note or comment.

2 fields
idstring
namestring | null
mentionsobject[]
3 fields
user_idstring
namestring | null
deletedboolean

true if the mentioned user has since been removed from the team.

created_atstring<date-time>
updated_atstring<date-time>
400
401
404
429