Skip to main content
GET
/
api
/
v1
/
contacts
Get paginated list of contacts
curl --request GET \
  --url https://{subdomain}.mindhunters.ai/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Contacts retrieved successfully",
  "data": {
    "current_page": 1,
    "data": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "surname": "<string>",
        "email": "<string>",
        "phone_number": "<string>",
        "number_type": "<string>",
        "country_code": "<string>",
        "timezone": "<string>",
        "primary_language": "<string>",
        "preferred_contact_channel": "<string>",
        "preferred_contact_time": "<string>",
        "status": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "tags": [
          {
            "id": 123,
            "name": "<string>"
          }
        ],
        "custom_field_1": "<string>",
        "custom_field_2": "<string>"
      }
    ],
    "first_page_url": "<string>",
    "last_page": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

page
integer
default:1

Page number

per_page
integer
default:15

Number of items per page

Search term for name, email, or phone

status
enum<string>

Filter by contact status

Available options:
Active,
Inactive

Response

Success

success
boolean
Example:

true

message
string
Example:

"Contacts retrieved successfully"

data
object