List conversations

GET

https://api.talktohumans.app

conversations

List conversations

curl --request GET \
  --url https://api.talktohumans.app/v1/conversations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.talktohumans.app/v1/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.talktohumans.app/v1/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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>",
            "relationship_status": "connected",
            "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_direction": "sent",
        "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 API key as Authorization: Bearer <api_key>.

Query Parameters

account_id

string[]

LinkedIn account IDs returned by GET /v1/accounts.

Repeat the query parameter for multiple accounts. The backend also accepts comma-separated values. If an explicit account target is not accessible to this credential, the API returns 403 account_shared_access_required.

Pattern: ^[1-9][0-9]*$

view_id

string

Filter by a saved inbox. Accepts the view id or an unambiguous public_id from GET /v1/views. Uses the view's account and filters. An explicit account_id scope must include that account. Results keep the endpoint's normal ordering.

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

Show child attributes

List conversations

curl --request GET \
  --url https://api.talktohumans.app/v1/conversations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.talktohumans.app/v1/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.talktohumans.app/v1/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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>",
            "relationship_status": "connected",
            "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_direction": "sent",
        "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>"
    }
  }
}

Conversations

Templates

Contacts

Companies

Enrich

Views

Accounts

Activity

Authorizations

Query Parameters

Response