SparrowDesk
Contacts

List contacts

Returns contacts for the authenticated account. Optional filters apply in addition to first-name search. Requires the "view contacts" scope.

GET
/contacts

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?string

Case-sensitive partial match on first name

requested_by_email?string

Exact match on contact email

Formatemail
requested_by_phone?string

Exact match on contact phone (E.164)

starting_after?string|null

Cursor for pagination (only needed for subsequent pages)

per_page?integer

Number of items per page (1-100, default 25)

Default25
Range1 <= value <= 100

Response Body

application/json

application/json

curl -X GET "https://app.sparrowdesk.com/v1/contacts"
{
  "data": [
    {
      "id": 0,
      "first_name": "string",
      "last_name": "string",
      "full_name": "string",
      "email": "[email protected]",
      "phone": "string",
      "language": "string",
      "time_zone": "string",
      "country": "string",
      "region": "string",
      "city": "string",
      "active": true,
      "unsubscribed": true,
      "blocked": true,
      "avatar": "string",
      "company_id": 0,
      "company_name": "string",
      "custom_fields": {},
      "properties": {},
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "pages": {
    "per_page": 0,
    "next_cursor": "string",
    "next_url": "string"
  },
  "total_count": 0
}
{
  "error": {
    "message": "string"
  }
}