Persons

WhatsApp Users who contacted your Inbox

get

Filter Persons by string query - search for Persons containing specified text phrase.

The API will search in following places:

• waba_payload.wa_id

• waba_payload.profile.name

Authorizations

AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Query parameters

limitintegerOptional

offsetintegerOptional

searchstringOptional

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=400&limit=100

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=200&limit=100

get/api/v1/persons/

GET /api/v1/persons/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "wa_id": "text",
      "bsuid": "text",
      "phone_number": "text",
      "waba_payload": {
        "profile": {
          "name": "text"
        },
        "wa_id": "text"
      },
      "initials": "text",
      "last_message_timestamp": 1,
      "messaging_window_expires_at": 1,
      "messaging_window_origin": "text",
      "resolved": true
    }
  ]
}

get

Authorizations

AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Path parameters

wa_idstringRequiredPattern: ^[^/]+$

Responses

200Success

application/json

wa_idstring · max: 200Required

WhatsApp ID — either a phone number in canonical form (e.g. 48123123123) or a Business-Scoped User ID (e.g. US.13491208655302741918) for users who have hidden their phone number.

Pattern: ^([A-Z]{2}\.(ENT\.)?[a-zA-Z0-9]+|[0-9]+)$

bsuidstring · nullableRead-onlyRequired

Business-Scoped User ID for this contact. Populated from the webhook's user_id field. Stable across phone number changes for the same user-portfolio pair, so this is the most reliable long-term identifier.

phone_numberstring · nullableRead-onlyRequired

Phone number when known. Equals wa_id for phone-primary contacts. For BSUID-primary contacts (where wa_id is a BSUID), populated when WhatsApp shares the phone number — e.g. recent interaction within the last 30 days, or via Contact Book.

initialsstringRequired

Contact user name initials used for display when avatar image is missing

last_message_timestampnumber · double · nullableOptional

POSIX timestamp of last message that was sent by this contact. It is the floor of the customer care messaging window: a non-template message can always be delivered for some time after the customer last wrote to your business, and Meta may keep the window open for longer — see messaging_window_expires_at. Read more at WhatsApp Business API docs Messages Cut-off Control.

messaging_window_expires_atnumber · doubleRead-onlyRequired

POSIX timestamp after which a non-template message to this contact is rejected with HTTP 453. Derived from what Meta reported for this conversation, the customer's last message, and — for click-to-WhatsApp chats we have not replied to yet — the ad referral. Never assume a fixed duration: read this value.

messaging_window_originstring · nullableRead-onlyRequired

conversation.origin.type reported by Meta alongside messaging_window_expires_at — what opened the conversation (e.g. service, marketing, utility, authentication, or referral_conversion for a click-to-WhatsApp ad).

resolvedbooleanOptional

Whether this chat is considered resolved by the assigned agent. Can automatically be set to false if contact keeps sending messages.

get/api/v1/persons/{wa_id}/

GET /api/v1/persons/{wa_id}/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Accept: */*

200Success

{
  "wa_id": "text",
  "bsuid": "text",
  "phone_number": "text",
  "waba_payload": {
    "profile": {
      "name": "text"
    },
    "wa_id": "text"
  },
  "initials": "text",
  "last_message_timestamp": 1,
  "messaging_window_expires_at": 1,
  "messaging_window_origin": "text",
  "resolved": true
}