FAQ

Authentication

What authentication method does the API use (e.g., API key, OAuth, JWT, etc.)?

We use a combination of API Key and OAuth Client Credential Grant. For detailed instructions, refer to our guide: Step 1: Get access to Avionté APIs.

Are there any specific scopes or permissions required for certain operations?

Yes, certain operations require specific scopes or permissions, but the scope is not too granular.

What's the lifetime of a token?

The token is valid for 1 hour (3600 seconds).

Rate limits

Are there rate limits or throttling rules? What are the limits?

Yes, Avionté APIs are rate-limited, and the limits vary by the API. Bulk APIs generally have stricter throttling, with limits of 3-5 requests per second (RPS).

What are the limits for retrieving data in bulk (e.g., maximum page size)?

The typical limit is 100 records per request. Some bulk endpoints that process heavy workloads may impose lower limits.

Requests and responses

What data formats are supported for requests and responses (e.g., JSON, XML)?

The API supports JSON for both requests and responses.

What standard headers are needed in every API request?

Each request must include the following headers:

accept: Specifies the expected response format. Set this to application/json to ensure you receive responses in JSON format.
FrontOfficeTenantId or Tenant:
- FrontOfficeTenantId: Tenant identifier for scoped data access during request.
- Tenant: A short code that indicates the tenant for which the request is being made. It is preferred to use FrontOfficeTenantId when available.
RequestId: A unique request GUID to correlate request data with log entries and events.
Authorization: Access token, formatted as Bearer {token}. Tokens are case-sensitive, and the word Bearer should always be capitalized.
X-api-key: Avionté API key. This key is case-sensitive and should match exactly as provided.

How to add headers in your API client:

Using Python (with requests):

headers = {
    "accept": "application/json",
    "FrontOfficeTenantId": "your-FrontOfficeTenantId",
    "RequestId": "your-RequestId",
    "Authorization": "Bearer your-token",
    "x-api-key": "your-api-key"
}

Using Postman: Navigate to the Headers tab in the request editor and add each key-value pair (e.g., X-api-key: your-api key) manually.

Is there a standardized error response structure? How are errors communicated (e.g., HTTP status codes, error codes, messages)?

Yes, errors are communicated using standard HTTP status codes along with detailed messages where applicable.

Data retrieval and querying

Do the APIs support query parameters for filtering, sorting, and pagination?

No, query parameters are not generally supported, except for operations related to talent.