Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Client Status

Search Client Statuses

Gets a list of Client Statuses given a search query.

get/clients/statuses/search

Query parameters

sortstring

Specifies the order in which the Client Status list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

qstring required

Search Value

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Response

List of Client Statuses

Example response

{
  "statuses": [
    {
      "id": 1234567891234567
    }
  ]
}