Get company groups
Changed onLists the company groups owned by the authenticated company. Company groups are the labels you use to organize your business relationships (your customers and vendors) — for example "Wholesale", "Retail", or a region — and price tiers can target or exclude companies by group.
Results are scoped to your company only; groups belonging to other companies are never returned. They come back sorted by creation time, oldest first, and are paginated: read next_page from the envelope and request that URL to fetch the following page (it is null on the last page).
Required permission: settings_permissions_company_relationship_groups.
Request
- Base URLhttps://app.distru.com
- AuthHTTP bearer
Query parameters
Restrict the result to specific company groups by ID (the same ID returned as each company group's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given.
Filter to company relationship groups by their creation datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range: 2022-07-10T00:00:00Z, matches on or after that instant, ,2022-07-10T00:00:00Z matches on or before it.
Filter to company relationship groups by their last-updated datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range.
Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.
Response
A list of company groups
Changes
- info
added the non-success response with the status
- info