Oquira BusinessSecurely access the Oquira Business API using keys.
API Keys allow you to authenticate requests to the Oquira Business API without using session cookies. They are ideal for server-to-server integrations.
Generate a new key for your organization. Make sure to copy the key immediately, as it will not be shown again.
POST /v1/organizations/{organizationId}/api-keys
X-API-Key: your_api_key_here
Content-Type: application/json
{
"name": "Production Integration Key",
"permissions": ["read", "write"]
}| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A descriptive name for the key. |
permissions | string[] | No | List of permissions: read, write, admin. |
View all active API keys for your organization. Note that the full key values are masked for security.
GET /v1/organizations/{organizationId}/api-keys
X-API-Key: your_api_key_herePermanently disable an API key. Any request using a revoked key will result in a 401 Unauthorized error.
DELETE /v1/organizations/{organizationId}/api-keys/{keyId}
X-API-Key: your_api_key_hereInclude the key in the X-API-Key header of your requests.
GET /v1/business/dashboard
X-API-Key: oq_abc123...