Skip to main content
GET
/
api
/
v1
/
contacts
List contacts
curl --request GET \
  --url http://localhost:{port}/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "number": "<string>",
      "isBusiness": true,
      "isEnterprise": true,
      "isMe": true,
      "isUser": true,
      "isGroup": true,
      "isWAContact": true,
      "isMyContact": true,
      "isBlocked": true,
      "pushname": "<string>",
      "shortName": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization
string
header
required

JWT token authentication

Query Parameters

page
number

Page number

limit
number

Items per page

query
string

Search query to filter contacts by name or number

Response

200 - application/json

Contacts retrieved successfully

List of contacts with pagination

data
object[]
required

Array of contacts

pagination
object
required

Pagination metadata