Skip to main content
GET
https://api.talktohumans.app
/
v1
/
conversations
List conversations
curl --request GET \
  --url https://api.talktohumans.app/v1/conversations \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "conversations": [
      {
        "conversation_id": "<string>",
        "account": {
          "account_id": "<string>",
          "display_name": "<string>",
          "provider_account_id": "<string>",
          "owner_user_id": "<string>"
        },
        "title": "<string>",
        "is_group": true,
        "participants": [
          {
            "contact_id": "<string>",
            "provider_participant_id": "<string>",
            "name": "<string>",
            "account_relationship_id": "<string>",
            "public_identifier": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "headline": "<string>",
            "primary_role_title": "<string>",
            "primary_company_name": "<string>",
            "linkedin_url": "<string>",
            "avatar_url": "<string>"
          }
        ],
        "app_url": "<string>",
        "last_message_text": "<string>",
        "last_message_at": "2023-11-07T05:31:56Z",
        "current_state": "<string>",
        "sequence": {
          "sequence_id": "<string>",
          "status": "<string>",
          "stop_if_person_replies": true,
          "steps": [
            {
              "step_id": "<string>",
              "step_type": "<string>",
              "trigger_type": "<string>",
              "position": 123,
              "message_mode": "<string>",
              "state": "<string>",
              "template_run_public_id": "<string>",
              "scheduled_for": "2023-11-07T05:31:56Z"
            }
          ],
          "reply_guard_after": "2023-11-07T05:31:56Z",
          "next_step_id": "<string>",
          "next_step_scheduled_for": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "pagination": {
      "limit": 10,
      "has_more": true,
      "next_cursor": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Pass your API key as Authorization: Bearer <api_key>.

Query Parameters

​
tag
string

Filter by a participant tag. The connected account's own profile is ignored.

​
contact_id
string

Filter by TalkToHumans contact ID. Use a positive integer encoded as a string.

Pattern: ^[1-9][0-9]*$
​
limit
integer
default:10

Page size. Defaults to 10. Values above 25 are clamped to 25.

Required range: 1 <= x <= 25
​
cursor
string

Opaque cursor from the previous response's pagination.next_cursor.

Response

Conversations matching the filters.

​
data
object
required