Companies
Get Company IDs
Returns a paged list of all company IDs registered in the system.
get/v1/companies/ids/{page}/{pageSize}
Request
- Base URLhttps://api.avionte.com/front-office
- URLhttps://api.avionte.com/front-office/v1/companies/ids/{page}/{pageSize}
- Auth
- API key in header x-api-key
- or HTTP bearer
Path parameters
pagestring required
The page number to retrieve in a paginated response.
pageSizestring required
The number of records to include per page in a paginated response.
Headers
RequestIdstring uuid
Unique request identifier in UUID format used to correlate request data to log entries and events.
Example:63680b86-c7e0-4a36-ae4a-d0d481089aff
Unique request identifier (UUID) used to correlate request data with log entries and events.
FrontOfficeTenantIdinteger
An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.
Tenantstring
Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.
Response
A paged list of company IDs.
Integer
Changes
No recorded changes to this operation across all 1 revision of this API.