Oquira BusinessManage waitlines, capacity, and real-time status of your queues.
Queues are where the actual waiting happens. Each service can have one or more queues with different configurations (e.g., "Regular", "VIP", "Direct Appointment").
Add a new queue to an existing service.
POST /v1/business/queues
X-API-Key: your_api_key_here
Content-Type: application/json
{
"serviceId": "ser_xyz...",
"name": "Standard Waitline",
"description": "General walk-in queue",
"maxCapacity": 50
}| Property | Type | Required | Description |
|---|---|---|---|
serviceId | string | Yes | ID of the parent service. |
name | string | Yes | Name of the queue. |
description | string | No | Short description. |
maxCapacity | number | No | Max number of waiting people allowed. |
Add a customer to the queue manually (e.g., at a physical kiosk or by an agent).
POST /v1/queues/{queueId}/operator-join
X-API-Key: your_api_key_here
Content-Type: application/json
{
"visitorName": "John Doe",
"partySize": 2
}Create a priority ticket that skip part of the waitline.
POST /v1/queues/{queueId}/vip-ticket
X-API-Key: your_api_key_here
Content-Type: application/json
{
"visitorName": "Premium Client",
"partySize": 1
}Pause, resume, or close a queue.
PATCH /v1/business/queues/{queueId}/status
X-API-Key: your_api_key_here
Content-Type: application/json
{
"status": "paused"
}| Value | Description |
|---|---|
active | Queue is open and accepting new tickets. |
paused | Queue is open but not accepting NEW tickets. Existing tickets can still be called. |
closed | Queue is closed. No new tickets, and no calling allowed. |
Operators can create tickets on behalf of walk-in visitors who don't have the app. These tickets are marked as ghost mode (isGhostMode: true), meaning no user-facing notifications are sent.
POST /v1/queues/{queueId}/operator-join
X-API-Key: your_api_key_here
Content-Type: application/json
{
"visitorName": "Marie Dupont",
"partySize": 2
}| Property | Type | Required | Description |
|---|---|---|---|
visitorName | string | No | Name of the walk-in visitor. |
partySize | number | No | Number of people in the group. Defaults to 1. |
Note: Requires the
QUEUE_OPERATEpermission. The ticket'suserIdis set to the operator's ID, andisGhostModeistrue.
Create a priority ticket that is placed at the front of the queue. Also marked as ghost mode.
POST /v1/queues/{queueId}/vip-ticket
X-API-Key: your_api_key_here
Content-Type: application/json
{
"visitorName": "VIP Client",
"partySize": 1
}Note: VIP tickets are placed ahead of regular waiting tickets. Requires the
QUEUE_OPERATEpermission.
POST /v1/queues/{queueId}/clear
X-API-Key: your_api_key_here
---
POST /v1/queues/{queueId}/archive
X-API-Key: your_api_key_here