Environments
API access may vary depending on the environment.Base URL
All API paths are built from this base: FlexxibleGenerate an API key
To create this key, the user must have the Organization administrator role.- Go to Settings → Organization.
- Select the API keys tab.
- Click Create API key.
-
Complete the form.
- Name. Identifier for the API key.
- Role. Role assigned to the user in Portal.
- Duration. Key validity period.
- 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:
- Go to Settings → Organization.
- Select the General → Details tab.
- 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.| Entity | Item limit |
|---|---|
| Tenants and delegated tenants | 100 |
| Organizations | 100 |
| Reporting groups | 500 |
| Workspace groups | 1000 |
| Workspace groups → Scheduling | 10 |
| Flows | 100 |
| Microservices | 500 |
| Reports | 500 |
| Web Apps | 100 |
| Webhooks | 100 |
| Licenses | 500 |
| Alert settings | 100 |
| Roles | 100 |
| Users | 1500 |
| Updates → Policies | 50 |
| Updates → Targets | 50 |
| Policies | 50 |
| Integrations | 10 |
| Report categories | 100 |
| Microservice categories | 100 |
| Domains | 5 |
| SSO integrations | 5 |
| Products | 15 |
| Modules | 50 |
| API Keys | 15 |