Skip to main content
POST
List units (Preview)

Authorizations

Authorization
string
header
required

Personal access token. Create one in Admin → Security → Developer Settings → Generate Personal Access Token.

Body

application/json
filters
object

MongoDB-style filters. The endpoint description lists the supported fields.

limit
integer
default:1000

Maximum number of results to return.

Required range: 1 <= x <= 1000
skip
integer
default:0

Number of results to skip before returning.

Required range: x >= 0
sort
object

MongoDB-style sort, for example { "createdAt": -1 }.

select
object

Fields to return, MongoDB projection style, for example { "primaryEmail": 1 }.

Response

200 - application/json

OK

dataLength
integer
data
object[]