List conversations

curl --request GET \
  --url https://{your-subdomain}.neetochat.com/api/external/v2/conversations \
  --header 'Accept: <accept>' \
  --header 'X-Api-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>', Accept: '<accept>'}};

fetch('https://{your-subdomain}.neetochat.com/api/external/v2/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetochat.com/api/external/v2/conversations"

headers = {
    "X-Api-Key": "<x-api-key>",
    "Accept": "<accept>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "conversations": [
    {
      "id": "de414e85-a1b5-4240-a465-7b32606980ce",
      "status": "open",
      "title": "Refund for order #1042",
      "priority": "low",
      "channel_name": "b945fd3cd2573017052901d6dbd0832f",
      "origin_page_url": "https://example.com/pricing",
      "origin_page_title": "Pricing",
      "created_at": "2026-09-23T18:07:53.661Z",
      "updated_at": "2026-10-05T16:26:58.143Z",
      "agent": {
        "id": "05665eee-4602-4317-8f7f-767b04274e5f",
        "name": "Oliver Smith",
        "email": "oliver@example.com"
      },
      "group": {
        "id": null,
        "name": null
      },
      "visitor": {
        "id": "2c79a334-0bc8-44e4-9504-331f59d400ab",
        "name": "Sam Brown",
        "email": "sam@example.com",
        "phone_number": null,
        "user_identifier": null
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 4,
    "total_count": 52,
    "per_page": 15
  }
}

{
  "error": "Invalid updated_after value. It must be an ISO 8601 timestamp."
}

GET

conversations

List conversations

curl --request GET \
  --url https://{your-subdomain}.neetochat.com/api/external/v2/conversations \
  --header 'Accept: <accept>' \
  --header 'X-Api-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>', Accept: '<accept>'}};

fetch('https://{your-subdomain}.neetochat.com/api/external/v2/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetochat.com/api/external/v2/conversations"

headers = {
    "X-Api-Key": "<x-api-key>",
    "Accept": "<accept>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "conversations": [
    {
      "id": "de414e85-a1b5-4240-a465-7b32606980ce",
      "status": "open",
      "title": "Refund for order #1042",
      "priority": "low",
      "channel_name": "b945fd3cd2573017052901d6dbd0832f",
      "origin_page_url": "https://example.com/pricing",
      "origin_page_title": "Pricing",
      "created_at": "2026-09-23T18:07:53.661Z",
      "updated_at": "2026-10-05T16:26:58.143Z",
      "agent": {
        "id": "05665eee-4602-4317-8f7f-767b04274e5f",
        "name": "Oliver Smith",
        "email": "oliver@example.com"
      },
      "group": {
        "id": null,
        "name": null
      },
      "visitor": {
        "id": "2c79a334-0bc8-44e4-9504-331f59d400ab",
        "name": "Sam Brown",
        "email": "sam@example.com",
        "phone_number": null,
        "user_identifier": null
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 4,
    "total_count": 52,
    "per_page": 15
  }
}

{
  "error": "Invalid updated_after value. It must be an ISO 8601 timestamp."
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key

string

default:your-api-key

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

enum<string>

default:application/json

required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:

application/json

Query Parameters

status

string

Filter conversations by status. Pass several statuses as a comma-separated list, such as open,waiting_on_customer.

Example:

"open"

updated_after

string<date-time>

Return only conversations updated after this time, as an ISO 8601 timestamp. A timestamp with a + offset must be URL-encoded (%2B05:30).

Example:

"2026-10-05T10:00:00Z"

sort

enum<string>

default:created_at

Field to sort conversations by. Defaults to created_at. Conversations with the same value are ordered by id.

Available options:

created_at,

updated_at

order

enum<string>

default:asc

Sort direction. Defaults to asc.

Available options:

asc,

desc

page

integer

Page number to retrieve, starting from 1. Defaults to 1 when omitted.

Example:

1

per_page

integer

Number of records per page. Defaults to 15 when omitted, and values above 100 are capped at 100. page_size is accepted as an alias.

Example:

15

Response

OK - Request succeeded

conversations

object[]

Hide child attributes

conversations.id

string<uuid>

Example:

"de414e85-a1b5-4240-a465-7b32606980ce"

conversations.status

string

Name of the conversation's status. The default statuses are new, open, waiting_on_customer, on_hold, closed, spam and trash, and your workspace may also have custom statuses.

Example:

"open"

conversations.title

string | null

Example:

"Refund for order #1042"

conversations.priority

enum<string>

Available options:

low,

medium,

high,

urgent

Example:

"low"

conversations.channel_name

string

Unique identifier of the conversation's chat channel.

Example:

"b945fd3cd2573017052901d6dbd0832f"

conversations.origin_page_url

string | null

URL of the page the conversation was started from.

Example:

"https://example.com/pricing"

conversations.origin_page_title

string | null

Title of the page the conversation was started from.

Example:

"Pricing"

conversations.created_at

string<date-time>

Example:

"2026-09-23T18:07:53.661Z"

conversations.updated_at

string<date-time>

Time the conversation was last changed. A new message or note in the conversation also updates it.

Example:

"2026-10-05T16:26:58.143Z"

conversations.agent

object

Team member assigned to the conversation. All fields are null when the conversation is unassigned.

Hide child attributes

conversations.agent.id

string<uuid> | null

Example:

"05665eee-4602-4317-8f7f-767b04274e5f"

conversations.agent.name

string | null

Example:

"Oliver Smith"

conversations.agent.email

string | null

Example:

"oliver@example.com"

conversations.group

object

Group assigned to the conversation. All fields are null when no group is assigned.

Hide child attributes

conversations.group.id

string<uuid> | null

Example:

null

conversations.group.name

string | null

Example:

null

conversations.visitor

object

Contact who started the conversation.

Hide child attributes

conversations.visitor.id

string<uuid>

Example:

"2c79a334-0bc8-44e4-9504-331f59d400ab"

conversations.visitor.name

string | null

Example:

"Sam Brown"

conversations.visitor.email

string | null

Example:

"sam@example.com"

conversations.visitor.phone_number

string | null

Example:

null

conversations.visitor.user_identifier

string | null

Example:

null

pagination

object

Hide child attributes

pagination.current_page

integer

Current page number.

Example:

1

pagination.total_pages

integer

Total number of pages available.

Example:

4

pagination.total_count

integer

Total number of records across all pages.

Example:

52

pagination.per_page

integer

Number of records per page.

Example:

15

Getting Started

Conversations

Messages

Team Members

List conversations

Headers

Query Parameters

Response