Skip to main content

ListCustomersQueryParamsModel

List customers query params.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"active": "Boolean, optional",
"created_on_gte": "String, optional",
"is_parent": "Boolean, optional",
"last_updated_gte": "String, optional",
"location_id": "Integer, optional",
"name": "String, optional",
"page_index": "Integer, optional",
"page_limit": "Integer, optional",
"parent_id": "Integer, optional"
}

Fields​

active Boolean, Optional

Default Value: NULL

If true, return only active records. If false, return only inactive records. If unspecified, return all.

  • One of 0, 1, True, False (case insensitive).

created_on_gte String, Optional

Return records created on or after the specified date. If unspecified, return all.

  • Date occurring in the past in an ISO 8601 compatible format.

is_parent Boolean, Optional

Default Value: NULL

If true, return accounts with no parent. If false, return accounts with a parent. If null, all records returned.

  • One of 0, 1, True, False (case insensitive).

last_updated_gte String, Optional

Return only records updated after (must be in past). If unspecified, return all.

  • Date occurring in the past in an ISO 8601 compatible format.

location_id Integer, Optional

If specified, return only records matching this location. If unspecified, return all location records.

name String, Optional

Name (free text).

  • At least 1 and no more than 64 characters.

page_index Integer, Optional

Paged results page index (starting from 1).

  • Less than or equal to 10000.
  • Greater than or equal to 1.

page_limit Integer, Optional

Maximun number of results per page.

  • Less than or equal to 1000.
  • Greater than or equal to 1.

parent_id Integer, Optional

Default Value: NULL

If specified, return only children of the specified parent_id.