List Contacts

Retrieve a paginated list of contacts from your workspace. Contacts are returned in descending order by creation time and include their attributes, subscription status, and metadata.

GET
/v1/workspaces/:workspace/contacts

List Contacts in your workspace

Path parameters

workspacestring Required

ID of your workspace

Request body

pagenumber

Query parameter for the page number (default 1)

per_pagenumber

Query parameter for records per page (default 10)

Request Example
curl "https://api.leadpush.io/v1/workspaces/:workspace/contacts?page=1&per_page=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
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"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 10,
    "total": 100,
    "last_page": 10
  }
}