List Contacts

Retrieves a paginated list of contacts with optional search filtering by name, email, or phone number.

List contacts

get
Authorizations
Query parameters
searchstringOptional

Search contacts by name, email, or phone

pageinteger · min: 1Optional

Page number for pagination

Responses
200

List of contacts

application/json
get
/contacts
GET /api/v1/contacts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

List of contacts

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "text",
      "last_name": "text",
      "email": "name@gmail.com",
      "phone_number": "text",
      "date_of_birth": "2025-10-19",
      "email_consent": false,
      "sms_consent": false,
      "whatsapp_consent": false,
      "created_at": "2025-10-19T02:22:27.371Z",
      "updated_at": "2025-10-19T02:22:27.371Z"
    }
  ],
  "links": {},
  "meta": {}
}

Last updated