Oquira BusinessManage your organization profile, settings, and business details.
Organizations are the primary entity in Oquira. They represent your business and contain all other resources like locations, services, and queues.
Create a new organization and become its owner.
POST /v1/organizations
X-API-Key: your_api_key_here
Content-Type: application/json
{
"name": "My Business",
"slug": "my-business",
"type": "retail",
"description": "Premium retail services"
}| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The official name of your business. |
slug | string | Yes | Unique URL-friendly identifier. Only lowercase letters, numbers, and hyphens. |
type | string | No | Category: retail, healthcare, banking, government, other. |
description | string | No | Short business description. |
Retrieve all organizations where the authenticated user is a member.
GET /v1/organizations
X-API-Key: your_api_key_hereUpdate your organization's business details. Fields like legalName, siret, and vatNumber are essential for business verification.
PATCH /v1/organizations/{organizationId}
X-API-Key: your_api_key_here
Content-Type: application/json
{
"name": "My Business Updated",
"legalName": "My Business SAS",
"website": "https://mybusiness.com",
"billingEmail": "billing@mybusiness.com",
"availabilityRadiusKm": 2
}| Property | Type | Description |
|---|---|---|
name | string | Public display name. |
legalName | string | Legal registered name of the business. |
website | string | Official website URL. |
billingEmail | email | Contact email for invoices. |
availabilityRadiusKm | number | Max distance for mobile join (0.1, 0.3, 0.5, 1, 2, 5, 10). |
Permanently delete an organization and all associated data (locations, services, members, etc.).
DELETE /v1/organizations/{organizationId}
X-API-Key: your_api_key_hereTransfer the ownership of the organization to another member. The previous owner will become an Admin.
POST /v1/organizations/{organizationId}/transfer-ownership
X-API-Key: your_api_key_here
Content-Type: application/json
{
"newOwnerId": "user_456..."
}