List Threads
Path Parameters
The unique identifier of the inbox.
Response
Returns an array of thread objects.Unique identifier for the thread.
ID of the organization that owns this thread.
ID of the inbox this thread belongs to.
Array of message IDs in this thread, in chronological order.
ISO 8601 timestamp of when the thread was created.
ISO 8601 timestamp of when the thread was last updated.
Error Responses
404 Not Found"Inbox not found"- The inbox doesn’t exist or doesn’t belong to your organization
Get Thread
Path Parameters
The unique identifier of the inbox.
The unique identifier of the thread to retrieve.
Response
Unique identifier for the thread.
ID of the organization that owns this thread.
ID of the inbox this thread belongs to.
Array of message IDs in this thread, in chronological order.Use the Get Message endpoint to retrieve the full details of each message.
ISO 8601 timestamp of when the thread was created.
ISO 8601 timestamp of when the thread was last updated.
Error Responses
404 Not Found"Thread not found"- The thread doesn’t exist or doesn’t belong to your organization, or doesn’t belong to the specified inbox
Working with Threads
Threads are automatically created when you send a message using the Send Message endpoint. When you reply to a message using the Reply to Message endpoint, the reply is automatically added to the same thread.Thread Lifecycle
- Creation: A thread is created automatically when you send a new message
- Growth: Additional messages are added to the thread when:
- You reply to a message in the thread
- You receive a reply from a recipient
- Retrieval: Use the List Threads or Get Thread endpoints to view thread information
Best Practices
- Use threads to group related messages together in your application UI
- Fetch thread details to show complete conversation history
- Monitor the
messagesarray to track conversation length - Use the
updatedAttimestamp to sort threads by recent activity