GET
/
v3
/
contacts
curl --request GET \
  --url https://api4.kinbox.com.br/v3/contacts \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 123,
  "data": [
    {
      "id": "<string>",
      "_id": "<string>",
      "customFields": {},
      "name": "<string>",
      "email": "<string>",
      "externalId": "<string>",
      "origin": "<string>",
      "phone": "<string>",
      "location": "<string>",
      "avatar": "<string>",
      "facebookId": "<string>",
      "instagramId": "<string>",
      "telegramId": "<string>",
      "notes": "<string>",
      "isImported": true,
      "hasConversation": true,
      "newContact": true,
      "crmData": {},
      "CustomerCustomField": {},
      "isPrivate": true,
      "workspaceId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "lastUpdateAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

newContact
boolean

Contato está na primeira sessão da primeira conversa

name
string
externalId
string
origin
string
phone
string
email
string
createdAtFrom
string
createdAtTo
string
ignoreCount
boolean
limit
number
default:20
required
Required range: 1 <= x <= 500
offset
number
default:0
required
Required range: x >= 0

Response

200 - application/json
totalCount
number

Total de registros

data
object[]