API Reference

Complete API Documentation

Everything you need to integrate NOWAITN's queue management into your applications.

Get Started View Endpoints

Authentication

The NOWAITN API uses API keys to authenticate requests. You can view and manage your API keys in your account dashboard.

Keep your API keys secure! Do not share them in publicly accessible areas such as GitHub, client-side code, etc.

Authentication is performed via the Authorization header using Bearer token authentication.

Authentication Header 
curl https://api.nowaitn.com/v1/queues \
  -H "Authorization: Bearer sk_live_xxx..."

Base URL

All API requests should be made to:

https://api.nowaitn.com/v1

API Endpoints

Queues

GET /queues List all queues
POST /queues Create a new queue
GET /queues/:id Retrieve a queue
PATCH /queues/:id Update a queue
DELETE /queues/:id Delete a queue

Guests

GET /queues/:id/guests List guests in a queue
POST /queues/:id/guests Add guest to queue
GET /guests/:id Retrieve a guest
PATCH /guests/:id Update a guest
POST /guests/:id/notify Send notification to guest
POST /guests/:id/seat Mark guest as seated
DELETE /guests/:id Remove guest from queue

Notifications

GET /notifications List all notifications
GET /notifications/templates List notification templates
POST /notifications/send Send custom notification

Example Request

Create a Guest

Add a new guest to a queue with optional party size and notes.

curl -X POST \
  https://api.nowaitn.com/v1/queues/queue_abc123/guests \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Smith",
    "phone": "+61412345678",
    "party_size": 4,
    "notes": "High chair needed"
  }'

Response

Returns the created guest object with queue position.

{
  "id": "guest_xyz789",
  "name": "John Smith",
  "phone": "+61412345678",
  "party_size": 4,
  "position": 3,
  "estimated_wait": 15,
  "status": "waiting",
  "created_at": "2024-01-15T10:30:00Z"
}

Error Codes

Code Status Description
400 Bad Request Invalid request parameters
401 Unauthorized Invalid or missing API key
403 Forbidden Access denied to resource
404 Not Found Resource does not exist
429 Rate Limited Too many requests
500 Server Error Internal server error

Need More Help?

Check out our guides, SDKs, or contact support.

View SDKs Read Guides