Customers

List contacts

Returns a list of contacts. The contacts are returned 20 results at a time and can be iterated over by using the page parameter.

get/contacts/public

Request

Query parameters

searchstring

Value used to search against the following fields: email, first name, last name, notes, phone, and account_id. Comparisons are not case sensitive and will match when the field value includes the search value as a substring.

pagestring

The page of results to return.

account_idinteger

The id of the account who's contacts to return. Must be an exact match.

Response

Successful response

account_idinteger nullable

the ID of the associated Account

createdstring
emailstring

email address (must be non-null, unique across all Contacts, and a valid email format)

first_namestring

Contact first name (must be non-null)

idinteger
last_namestring

Contact last name (must be non-null)

phonestring nullable

Contact phone number

phone_extstring nullable

Contact phone number extension

Example response

[
  {
    "account_id": 17,
    "created": "2020-08-25T18:00:53+00:00",
    "email": "careers@paperlessparts.com",
    "first_name": "Gordon",
    "id": 137,
    "last_name": "Moore",
    "phone": "6176354500"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.