Skip to main content
GET
/
contacts
cURL
curl --request GET \
  --url https://api.alpharun.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "contacts": [
      {
        "id": "contact123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone_number": "+1234567890",
        "ext_id": "ext_contact_789",
        "custom_fields": [
          {
            "key": "preferred_contact_method",
            "display_name": "Preferred Contact Method",
            "type": "text",
            "value": "email"
          }
        ]
      }
    ]
  },
  "next_cursor": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:20

Maximum number of contacts to return in a single response. Defaults to 20. Must be between 1 and 100; values outside this range return a 400.

Required range: 1 <= x <= 100
​
cursor
string | null

Pagination cursor returned as next_cursor in a previous response. Omit on the first request.

Response

List of contacts in the company

​
data
object
​
next_cursor
string | null

Cursor to pass as the cursor query parameter to fetch the next page. null when there are no more results.