Skip to main content
GET
/
contacts
Error
A valid request URL is required to generate request examples
[
  {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  }
]

Authorizations

authorization
string
header
required

Query Parameters

page
integer
default:1

Page #

per_page
integer
default:25

Page Size

Required range: 1 <= x <= 100
updated_since
integer

Unix Time

category_types
enum<string>[]
Available options:
client,
collaborator,
general_contractor,
manufacture,
project_manager,
purchasing_agent,
subcontractor,
supplier,
warehouse

Response

OK

id
integer
name
string
data
object

The details of the contact encoded in JSON format.

addresses
object[]
people
object[]
category
object