Oquira BusinessManage the services you offer at your business locations.
Services represent the actual offerings at your locations (e.g., "General Checkup", "Customer Support", "Package Pickup"). Each service can have multiple queues.
Create a new service for your organization. Services are linked to a specific location.
POST /v1/services
X-API-Key: your_api_key_here
Content-Type: application/json
{
"name": "General Consultation",
"description": "General medical checkup and consultation",
"serviceTypeId": "type_123...",
"locationIds": ["loc_abc..."],
"isVirtual": false,
"maxRemoteJoinRadiusKm": 5
}| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the service. |
locationIds | string[] | Yes | Array of physical location IDs. |
serviceTypeId | string | Yes | ID of the predefined service category. |
isVirtual | boolean | No | If true, service is provided online/remotely. |
maxRemoteJoinRadiusKm | number | No | Max distance for customers to join remotely. |
Retrieve all services owned by your organization, including their associated queues and statistics.
GET /v1/business/services
X-API-Key: your_api_key_hereRetrieve full details for a specific service.
GET /v1/services/{serviceId}
X-API-Key: your_api_key_hereModify service configuration or details.
PATCH /v1/services/{serviceId}
X-API-Key: your_api_key_here
Content-Type: application/json
{
"name": "Urgent Consultation",
"maxRemoteJoinRadiusKm": 10
}Remove a service and its associated queues.
DELETE /v1/services/{serviceId}
X-API-Key: your_api_key_hereSearch for services within your organization. By default, only active services are returned. Pass activeOnly=false to include all services regardless of status (useful for management dashboards).
GET /v1/services/organization/search?organizationId={orgId}&activeOnly=false
X-API-Key: your_api_key_here| Parameter | Type | Required | Description |
|---|---|---|---|
organizationId | string | Yes | Organization ID to search within. |
q | string | No | Search query to filter by service name. |
activeOnly | boolean | No | If false, returns all services (active, inactive, pending, rejected). Defaults to true. |
Note: This endpoint requires the
SERVICE_VIEWorganization permission. Operators, managers, and owners can all access it to see all organization services — not just the ones they own.
Get a list of available service categories for your organization type.
GET /v1/services/types?organizationType=retail
X-API-Key: your_api_key_here