Sign in

v1

latestOpenAPI 3.1.12026-07-17111158225.7 KB
contacts

List contacts

List contacts in the account.

get/{account}/contacts

Path parameters

accountinteger required

The account id

Query parameters

sort'id:asc' | 'id:desc' | 'label:asc' | 'label:desc' | 'email:asc' | 'email:desc'

Sort results. Default sorting is by id ascending.

Response

Successfully retrieved account contact list.

Example response

{
  "data": [
    {
      "id": 1,
      "account_id": 1010,
      "label": "Default",
      "first_name": "First",
      "last_name": "User",
      "organization_name": "Awesome Company",
      "job_title": "CEO",
      "address1": "Italian Street, 10",
      "address2": "",
      "city": "Roma",
      "state_province": "RM",
      "postal_code": "00100",
      "country": "IT",
      "phone": "+1.8001234567",
      "fax": "+1.8011234567",
      "email": "first@example.com",
      "created_at": "2013-11-08T17:23:15Z",
      "updated_at": "2015-01-08T21:30:50Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_entries": 2,
    "total_pages": 1
  }
}