Skip to navigation
Company

Get Companies

Retrieve a paginated list of companies for the tenant. Each row is filtered to the same public fields as Get Company by UUID for OAuth clients.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

vnd.a1.tenant-idstringOptional

Tenant identifier for multi-tenant environments

Query parameters

pageintegerOptional
Page number to retrieve. Starts from 1.
limitintegerOptional
Maximum number of records to return per page.
searchstringOptional
Search keyword to filter companies.
isEnabledbooleanOptional
Filter by enabled status.
searchColenumOptional
Column to search on.
Allowed values:
searchValstringOptional

Value to search for in searchCol.

sortColumnstringOptional
Field to sort results by.
sortOrderenumOptional
Sort direction.
Allowed values:
includestringOptional

Comma-separated list of field paths to include in each row (e.g. uuid,name).

Response

Successful Response
rowslist of objectsOptional
totalCountintegerOptional
Total number of matching companies.
currentPageintegerOptional
limitintegerOptional
totalPagesintegerOptional