API referenceReferenceAccounts
Headers - List
List account headers (account groups) for the selected business. Supports name search and returns hierarchy metadata (parent and level).
Path Parameters
business_slug*string
Business slug that scopes this request. If you do not have one yet, call common_accessible_businesses_list and pick a slug from the response.
Query Parameters
page?integer
A page number within the paginated result set.
page_size?integer
Number of results to return per page.
search?string
A search term.
The following fields are searched:
| field | match mode |
|---|---|
name | contains |
Response Body
application/json
curl -X GET "https://example.com/v1/business/string/header/"{ "count": 123, "next": 2, "prev": 1, "size": 30, "results": [ { "id": 0, "name": "string", "name_translations": [ { "key": "string", "value": "string" } ], "type": "B", "parent_id": 0, "parent_ids": [ 0 ], "level": 0 } ]}