List Chats

Get full or filtered list of all chats in the Workspace.

curl --request GET \
  --url https://app.timelines.ai/integrations/api/chats \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.timelines.ai/integrations/api/chats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.timelines.ai/integrations/api/chats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.timelines.ai/integrations/api/chats"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.timelines.ai/integrations/api/chats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "ok",
  "data": {
    "has_more_pages": true,
    "chats": [
      {
        "id": "1000001",
        "name": "John Doe",
        "jid": "14840000000@s.whatsapp.net",
        "is_group": false,
        "closed": false,
        "read": true,
        "labels": [
          "label1",
          "label2",
          "label3"
        ],
        "chatgpt_autoresponse_enabled": true,
        "whatsapp_account_id": "972502222222@s.whatsapp.net",
        "chat_url": "https://app.timelines.ai/chat/1000001/messages/",
        "created_timestamp": "2024-01-08 10:35:18 +0200",
        "unattended": false,
        "photo": "https://acme.com/logo.png",
        "phone": "+972501111111",
        "responsible_email": "kate.smitch@acme.com",
        "responsible_name": "Kate Smith",
        "last_message_uid": "4f43a9a0-b87e-4667-adfd-689674c3326c",
        "last_message_timestamp": "2024-01-29 13:55:04 +0200",
        "last_message": {
          "uid": "de919486-0c93-409d-ae66-c2bbb544faca",
          "chat_id": "1000001",
          "timestamp": "2023-06-18 15:19:23 +0300",
          "received_timestamp": "2023-06-18 14:39:25 +0300",
          "sender_phone": "+972540000001",
          "sender_name": "John Doe",
          "recipient_phone": "+972540000002",
          "recipient_name": "Kate Smith",
          "from_me": true,
          "status": "Read",
          "origin": "Public API",
          "has_attachment": true,
          "message_type": "Note",
          "data": {
            "key1": "value1",
            "key2": "value2"
          },
          "created_by": "Kate Smith",
          "text": "Hello, Kate👍",
          "attachment_url": "https://acme.com/logo.png",
          "attachment_filename": "logo.png"
        },
        "group_members": [
          {
            "name": "John Doe",
            "phone": "+972502222222",
            "role": "admin",
            "chat_id": 123456
          }
        ],
        "is_allowed_to_message": true
      }
    ]
  }
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

GET

chats

Get full or filtered list of all chats in the Workspace.

curl --request GET \
  --url https://app.timelines.ai/integrations/api/chats \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.timelines.ai/integrations/api/chats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.timelines.ai/integrations/api/chats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.timelines.ai/integrations/api/chats"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.timelines.ai/integrations/api/chats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "ok",
  "data": {
    "has_more_pages": true,
    "chats": [
      {
        "id": "1000001",
        "name": "John Doe",
        "jid": "14840000000@s.whatsapp.net",
        "is_group": false,
        "closed": false,
        "read": true,
        "labels": [
          "label1",
          "label2",
          "label3"
        ],
        "chatgpt_autoresponse_enabled": true,
        "whatsapp_account_id": "972502222222@s.whatsapp.net",
        "chat_url": "https://app.timelines.ai/chat/1000001/messages/",
        "created_timestamp": "2024-01-08 10:35:18 +0200",
        "unattended": false,
        "photo": "https://acme.com/logo.png",
        "phone": "+972501111111",
        "responsible_email": "kate.smitch@acme.com",
        "responsible_name": "Kate Smith",
        "last_message_uid": "4f43a9a0-b87e-4667-adfd-689674c3326c",
        "last_message_timestamp": "2024-01-29 13:55:04 +0200",
        "last_message": {
          "uid": "de919486-0c93-409d-ae66-c2bbb544faca",
          "chat_id": "1000001",
          "timestamp": "2023-06-18 15:19:23 +0300",
          "received_timestamp": "2023-06-18 14:39:25 +0300",
          "sender_phone": "+972540000001",
          "sender_name": "John Doe",
          "recipient_phone": "+972540000002",
          "recipient_name": "Kate Smith",
          "from_me": true,
          "status": "Read",
          "origin": "Public API",
          "has_attachment": true,
          "message_type": "Note",
          "data": {
            "key1": "value1",
            "key2": "value2"
          },
          "created_by": "Kate Smith",
          "text": "Hello, Kate👍",
          "attachment_url": "https://acme.com/logo.png",
          "attachment_filename": "logo.png"
        },
        "group_members": [
          {
            "name": "John Doe",
            "phone": "+972502222222",
            "role": "admin",
            "chat_id": 123456
          }
        ],
        "is_allowed_to_message": true
      }
    ]
  }
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

label

string

filters chats having at least one of specified labels (comma-separated)

whatsapp_account_id

string

filters chats belonging to one of the specified WhatsApp accounts (in wid format, comma-separated)

group

boolean

filters chats that are either group chats (true) or direct chats (false)

responsible

string

filters chats assigned to specific users (denoted by email address, comma-separated)

name

string

filter chats that contain any of specified strings (case-insensitive, comma-separated). Note: a string containing a whitespace will be matched as exact substring without being split to words.

phone

string

Filter direct (non-group) chats by a single phone number. Phone is sanitized in the same way as for sending messages. If sanitized value starts with '+', the match is exact. Otherwise, leading zeroes are removed and the number is matched as a substring of the stored phone. Group chats are always excluded when this parameter is used.

read

boolean

filter chats that are either read (true) or unread (false)

closed

boolean

filter chats that are either closed (true) or open (false)

chatgpt_autoresponse_enabled

boolean

filter chats where chatgpt auto-response is enabled (true) or disabled (false)

page

integer

specify the page of results (each page contains up to 50 items), starting with 1. Check "has more page" response value to see if more pages are available.

created_after

string<date-time>

filter chats that were created after this timestamp, can be specified with created_before

created_before

string<date-time>

filter chats that were created before this timestamp, can be specified with created_after

whatsapp_phone

string

Filter chats by contact phone number(s) (comma-separated). Each number is matched both against the direct chat's phone (tolerating a leading 0 in place of the country code, or an already-international number) and against group membership, so groups containing a matching member are included too.

with_msg

boolean

when true, include the full last_message object (in addition to last_message_uid / last_message_timestamp) for each chat.

Response

Success

status

enum<string>

required

Available options:

ok,

error

Example:

"ok"

data

object

required

Show child attributes

Overview

Chats

Messages

Reactions

Files

Labels

WhatsApp Accounts

Workspace

Teammates

Webhooks

Authorizations

Query Parameters

Response