Skip to main content
subdivisions

List /subdivisions

List client subdivisions (optional query matches name). Each item includes uuid, name, client (uuid + name), address and city. Subdivisions belong to a client, so use the client filter to narrow the list. The uuid is what the object subdivision field expects. Response: items and pagination.

GET
/subdivisions
Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

querystringquery

Optional search phrase (matches name).

Minimum string length: 1
pageintegerquery

Page number (1-based).

Required range: 1 <= x
per_pageintegerquery

Number of results per page. limit is accepted as an alias.

Required range: 1 <= x <= 500
filter[client]stringquery

Owning client UUIDs.

sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: address, city, name, uuid. Default when omitted: title.

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

application/json

Search results

itemsobject[]
paginationobject
querystring