PostZen
Queues

Get a queue schedule

GET
/v1/queue/slots

Returns the queue selected by queueId, or the profile's default queue when queueId is omitted. With all=true every queue on the profile is returned instead. nextSlots holds the next five instants the queue would hand out, already skipping occupied slots; a paused or slotless queue returns an empty array.

Authorization

bearerAuth
AuthorizationBearer <token>

PostZen API key.

In: header

Query Parameters

profileId*string

Profile that owns the queue.

queueId?string

Specific queue. Defaults to the profile's default queue. Cannot be combined with all=true.

all?boolean

Return every queue on the profile instead of a single schedule.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/queue/slots?profileId=string"
{  "exists": true,  "schedule": {    "_id": "string",    "profileId": "string",    "name": "string",    "description": "string",    "timezone": "string",    "slots": [      {        "dayOfWeek": 0,        "time": "string"      }    ],    "active": true,    "isDefault": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "nextSlots": [    "2019-08-24T14:15:22Z"  ]}
{  "error": "JSON body is required"}
{  "error": "Unauthorized"}
{  "error": "API key requires read_write permission"}
{  "error": "Not found"}
{  "error": "rate_limited",  "retryAfter": 30}
{  "error": "Failed to create post"}