Skip to main content
GET
/
api
/
v1
/
contacts
Get paginated list of contacts
curl --request GET \
  --url https://{subdomain}.mihu.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": [
          {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ]
      }
    ],
    "first_page_url": "<string>",
    "last_page": 123,
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.mindhunters.ai/llms.txt

Use this file to discover all available pages before exploring further.

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
string

Search term for name, email, or phone

​
status
enum<string>

Filter by contact status

Available options:
Active,
Inactive
​
contact_channel
enum<string>

Filter by preferred contact channel

Available options:
Call,
SMS,
WhatsApp
​
stage_uuid
string<uuid>

Filter by the contact's current pipeline stage UUID

​
campaign_uuid
string<uuid>

Filter by campaign UUID (matches contacts whose pool is attached to this campaign)

​
tag_uuid
string<uuid>

Filter by tag UUID

​
pool_uuid
string<uuid>

Filter by contact pool UUID

​
date_from
string<date>

Filter contacts created on or after this date (Y-m-d)

​
date_to
string<date>

Filter contacts created on or before this date (Y-m-d)

Response

Success

​
success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

​
message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Contacts retrieved successfully"

​
data
object