Listing Contacts

Beta

Retrieve a paginated list of contacts from your workspace. This endpoint allows you to fetch all contacts with their attributes, subscription status, and metadata for integration with your applications.

GET

List Contacts

https://api.leadpush.io/v1/workspaces/{workspace_uuid}/contacts

List Contacts in your workspace

Path parameters

workspace_uuidstring Required

ID of your workspace

Request body

pagenumber

Page number

Request Example
curl https://api.leadpush.io/v1/workspaces/{workspace_uuid}/contacts \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}" \
  -d page="1"
Response Example
{
  "data": [
    {
      "uuid": "<contact_uuid>",
      "subscribed": true,
      "attributes": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john_doe@leadpush.io",
        "phone": "+1234567890"
      },
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-01-01T00:00:00.000Z"
    }
    // Records...
  ],
  "meta": {
    "current_page": 1,
    "per_page": 10,
    "total": 100,
    "last_page": 10
  }
}