Skip to navigation

Get Rate Cards

Retrieve a paginated list of rate cards for the tenant. Each row is filtered to the same public fields as Get Rate Card 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.
sortColumnenumOptional

Field to sort results by. Defaults to rateCardName.

Allowed values:
sortOrderenumOptional
Sort direction.
Allowed values:
searchColumnstringOptional
Column to search on.
searchValuestringOptional

Value to search for in searchColumn.

includestringOptional

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

Response

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