Skip to main content
This document describes the steps required to make your first calls to the Flexxible API.

​
Environments

API access may vary depending on the environment.

​
Base URL

All API paths are built from this base: Flexxible
FXXOne

​
Generate an API key

To create this key, the user must have the Organization administrator role.
  1. Go to Settings → Organization.
  2. Select the API keys tab.
  3. Click Create API key.
  4. Complete the form.
    • Name. Identifier for the API key.
    • Role. Role assigned to the user in Portal.
    • Duration. Key validity period.
  5. Confirm with Save.

​
Authenticate requests

Every request must include the key in the Authentication header using the Bearer scheme: Authentication: Bearer <api_key> Although the Bearer scheme is used, the value corresponds directly to an API key generated on the platform, not to a token obtained through an additional authentication process.

​
Get the organization ID

Each endpoint requires the organization ID as the first path segment. https://api.flexxible.net/v2/organizations/:organization_id/{endpoint} To find the organization ID:
  1. Go to Settings → Organization.
  2. Select the General → Details tab.
  3. Copy the identifier.

​
OpenAPI contract

Download the OpenAPI contract in JSON format to consult the full API specification and make integrations easier.

​
Limits

To ensure the service’s stability, performance, and availability, the platform applies logical limits to the maximum number of items that a tenant can store for each entity available in the API. These limits do not correspond to API request limits (rate limits); instead, they define the maximum number of items of each entity type that a tenant can have at any given time. These limits apply by default in all environments.