Sign in

v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-1770249709.0 KB
Representatives

List representatives

Returns a list of representatives associated with a specific account or organization. The representatives are returned sorted by creation date, with the most recently created representatives appearing first. This endpoint supports advanced sorting and filtering options.

get/v1/representatives

Query parameters

account_idstring uuid

The unique identifier of the account to list representatives for.

The unique identifier of the account to list representatives for.

page_numberinteger

Results page number. Starts at page 1.

Results page number. Starts at page 1.

page_sizeinteger

Page size. Default value: 100. Max value: 1000

Page size. Max value: 1000

sort_bystring

Sort By. Default value: 'id'.

Sort By.

sort_order'asc' | 'desc'

Sort Order. Default value: 'asc'.

Sort Order.

platform_idstring uuid
organization_idstring uuid
level'account' | 'platform'

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

Optional client generated identifier to trace and debug a series of requests.

Response

OK

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Example response

{
  "data": [
    {
      "first_name": "Ron",
      "last_name": "Swanson",
      "dob": "1980-01-01",
      "ssn_last4": "1234",
      "email": "ron.swanson@pawnee.com",
      "mobile_number": "+12128675309"
    }
  ]
}