get/phone/sms/threads

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/phone/sms/threads
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

agentIdstring

Filter conversations to one agent. Optional for master keys (omit for every agent in the org); ignored for agent keys, which always see only their own.

limitinteger

Maximum conversations to return per page (1–100, default 20)

offsetinteger

Conversations to skip, for paging through the list

unreadboolean

When true, return only conversations with at least one unread message

Response

OK

totalinteger required

Total conversations matching the query

hasMoreboolean required

Whether more conversations exist past this page

Changes

No recorded changes to this operation across all 1 revision of this API.