List Contacts

Returns a list of contacts excluding archived.

Query Parameters

start_cursor string
The start cursor for Keyset pagination.
per_page integer
Possible values: >= 2 and <= 100
Default value: 50
The number of records per page to return
filter object
The fields, operations, and values to filter the records by.
- email object
  oneOf
  MOD1
  MOD2
  like string required
- last_name object
  oneOf
  MOD1
  MOD2
  like string required
- group_id object
  eq string required
- created_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- updated_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
sort object
The fields and direction to sort the results by.
- group_id string
  Possible values: [asc, desc]
- created_at string
  Possible values: [asc, desc]
- updated_at string
  Possible values: [asc, desc]
- id string
  Possible values: [asc, desc]
  Default value: desc

Responses

application/json

Schema
Example (from schema)

Schema

start_cursor string
The current start cursor of the records returned.
next_cursor string
The next cursor to retrieve the next page of records.
per_page integer
The maxumum number of records returned.
estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
MOD4
MOD5
email object
oneOf
MOD1
MOD2
like string
sorted_by object[]
The sorts applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
MOD4
group_id string
Possible values: [asc, desc]
records object[]

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "email": {
        "like": "string"
      }
    },
    {
      "last_name": {
        "like": "string"
      }
    },
    {
      "group_id": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "group_id": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "archived_at": "2023-03-14T13:46:27-06:00",
      "email": "string",
      "name": "string",
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "group_id": 0,
      "group_name": "string",
      "group_hierarchy": "Group 1|Group 2|Group 3",
      "technician": true,
      "vehicle_operator": true,
      "employee": true,
      "birth_date": "2023-03-14",
      "street_address": "123 Main St",
      "street_address_line_2": "Apt 1",
      "city": "string",
      "region": "string",
      "postal_code": "string",
      "country": "string",
      "employee_number": "string",
      "job_title": "string",
      "license_class": "string",
      "license_number": "string",
      "license_state": "string",
      "home_phone_number": "string",
      "mobile_phone_number": "string",
      "work_phone_number": "string",
      "other_phone_number": "string",
      "start_date": "2024-04-24",
      "leave_date": "2024-04-24",
      "hourly_labor_rate_cents": 0,
      "attachment_permissions": {
        "read_photos": true,
        "manage_photos": true,
        "read_documents": true,
        "manage_documents": true
      },
      "default_image_url": "string",
      "account_membership_id": 0,
      "custom_fields": {},
      "images": [
        {
          "id": 0,
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "imageable_id": 0,
          "imageable_type": "ExpenseEntry",
          "file_name": "string",
          "file_mime_type": "image/jpeg",
          "file_size": 0,
          "file_url": "string",
          "full_url": "string"
        }
      ],
      "images_count": 0
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (from schema)

Schema

errors object
type
items string

{
  "errors": {}
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}