Academy9

Activities10

Agent Templates5

Agents19

API Tokens3

App7

Apps5

Audit3

Calls2

Campanhas10

Campos Customizados2

Channels1

Commissions9

Contatos7

Conversations2

Copilot21

Credentials5

Dashboards10

Deal Imports6

Flow Defs1

Goal7

Google Ads3

Grupos2

Horários2

Knowledges5

MCP6

Messages2

Meta Ads3

Meta Conversions2

Monthly Brief2

Negócios10

News8

Notifications5

Onboarding4

Operadores3

Organizações14

Partner Templates6

Pipelines5

Presenças4

Produtos6

Push Notifications5

QuickPhrases5

Rating2

Relatórios21

Rpgs4

Signals4

SystemMetrics1

Tags5

Tasks8

Tools6

Usage Logs3

UserInfo10

v1AgentToolExecutions1

v1Campaigns8

v1Channels4

v1Contacts4

v1CustomFields2

v1Deals5

v1Groups4

v1Messages4

v1Organizations8

v1Pipelines5

v1Products6

v1QuickPhrases2

v1Sessions2

v1Tags5

Voip9

Wallet Alerts2

Warnings5

Webhooks8

WhatsApp API39

Widget8

Workflows14

Workspace Cleanup7

Workspace Stats6

WorkspaceDaily4

Workspaces10

v1Sessions

List all sessions

Changed on Sep 15, 2026

get/v1/sessions

Request

Base URL: https://api4.kinbox.com.br (the document declares no server; this is the origin it was published from)
URL: https://api4.kinbox.com.br/v1/sessions
Auth: none declared

Query parameters

limitnumber

A limit on the number of objects to be returned. Limit can range between 1 and 100.

cursorstring

A cursor for use in pagination. The cursor is the id of the last object returned in the previous request.

campaign_idstring

Filter sessions by campaign id.

contact_idstring

Filter sessions by the id of the contact associated with the session.

call_idstring

Filter sessions by the id of the call associated with the session.

updated_at_fromstring

Only return sessions that were updated after this date (ISO 8601). If no timezone offset is given (e.g. 2026-09-22 or 2026-09-22T10:00:00), the date is interpreted in the workspace timezone.

updated_at_tostring

Only return sessions that were updated before this date (ISO 8601). If no timezone offset is given (e.g. 2026-09-22 or 2026-09-22T10:00:00), the date is interpreted in the workspace timezone.

Response

nextCursorstring nullable required

Cursor for the next page. Null if there are no more results.

Example response

{
  "data": [
    {
      "id": "66e2f1c9a1b2c3d4e5f60718",
      "_id": "66e2f1c9a1b2c3d4e5f60718",
      "workspaceId": 1,
      "call": {
        "id": 987654,
        "customerPlatformId": 1234567,
        "workspacePlatformId": 103,
        "operatorId": 42,
        "groupId": 10,
        "protocol": "2026091412345",
        "customFields": {
          "origem": {
            "value": "site"
          }
        },
        "createdAt": "2026-09-14T11:58:00.000Z",
        "answeredAt": "2026-09-14T12:00:00.000Z",
        "finishedAt": "2026-09-14T12:30:00.000Z"
      },
      "contact": {
        "id": 555,
        "name": "João Silva",
        "email": "joao@gmail.com",
        "phone": "5585988887777",
        "createdAt": "2026-01-10T10:00:00.000Z",
        "customFields": {
          "cpf": {
            "value": "000.000.000-00"
          }
        }
      },
      "conversation": {
        "id": 1234567,
        "workspacePlatformId": 103,
        "identifier": "5585988887777"
      },
      "lastMessage": {
        "idMessage": 37826587,
        "content": "[{\"insert\":\"Olá\"}]",
        "createdAt": "2026-09-14T12:30:00.000Z"
      },
      "rating": {
        "value": 5
      },
      "trails": [
        {
          "date": "2026-09-14T12:00:00.000Z",
          "isodate": "2026-09-14T12:00:00.000Z",
          "type": "operator",
          "id": 42
        }
      ],
      "interactions": [
        {
          "date": "2026-09-14T12:00:00.000Z",
          "operatorId": 42
        }
      ],
      "interactionDates": [
        "2026-09-14"
      ],
      "tags": [
        3,
        8
      ],
      "operatorMessagesCount": 4,
      "assignedOperatorMessagesCount": 4,
      "botMessagesCount": 2,
      "contactMessagesCount": 5,
      "totalMessagesCount": 11,
      "messagesCountByDate": {
        "2026-09-14": {
          "bot": 2,
          "operator": 4,
          "contact": 5
        }
      },
      "tma": 1800,
      "tme": 120,
      "tmp": 90,
      "createdAt": "2026-09-14T11:58:00.000Z",
      "updatedAt": "2026-09-14T12:30:00.000Z"
    }
  ]
}

Changes

Sep 15, 2026b2a10af596db Revision changes
- breaking
  the response's property type changed from object to string for status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history