Passer au contenu principal
GET
/
v1
/
api
/
contacts
Search Contacts
curl --request GET \
  --url https://api.withallo.com/v1/api/contacts \
  --header 'Authorization: <api-key>'
{
  "data": {
    "results": [
      {
        "id": "cnt_abc123",
        "name": "John",
        "last_name": "Doe",
        "company": {
          "name": "Acme Corp",
          "id": "com_xyz789"
        },
        "job_title": "Manager",
        "website": null,
        "status": "active",
        "is_archived": false,
        "created_at": "2024-01-10T08:00:00",
        "updated_at": "2024-01-15T10:30:00",
        "numbers": [
          "+1234567890"
        ],
        "is_whitelisted": true,
        "last_activity_date": "2024-01-15T10:30:00",
        "engagement": "ENGAGED"
      }
    ],
    "metadata": {
      "pagination": {
        "total_pages": 5,
        "current_page": 0
      }
    }
  }
}

Autorisations

Authorization
string
header
requis

Scope needed: CONTACTS_READ

Paramètres de requête

size
integer
défaut:10

Number of results per page. Must be between 1 and 100.

Plage requise: 1 <= x <= 100
page
integer
défaut:0

Page number (0-indexed).

Plage requise: x >= 0

Réponse

Contacts retrieved successfully

Standard response wrapper for paginated contact results

data
object