Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
contacts,
interactions,
organisation,
properties
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by account ID(s)
  • has_property: Filter accounts by property ID(s)

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of customer accounts.

JSON API response object

data
A list of customer accounts · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a customer account is returned