Manage Circles
List, create, fetch, and soft-delete travel circles.
Manage Circles
Core CRUD for circles. All endpoints authenticate as the end user with a Bearer JWT plus the X-App-Id and X-Environment headers.
List Circles
GET /v1/circle
Returns all active circles the authenticated user belongs to. No request body or query parameters.
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/circleSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X GET 'https://cloud.vanitypass.com/v1/circle' \ -H 'Content-Type: application/json' \ -H 'X-Environment: Sandbox' \
Create a Circle
POST /v1/circle
Creates a new travel circle owned by the authenticated user.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Display name for the circle. |
description | string | yes | Free-text description of the trip or group. |
purpose | string | no | One of stays, dining, experiences. |
booking_managed_by | string | no | Who manages bookings for the circle. |
unique_code | string | no | Custom code for the circle (e.g. a shareable join code). |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/circleSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X POST 'https://cloud.vanitypass.com/v1/circle' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \
-d '{"name":"Summer in Dubai","description":"Family trip, July 2026","purpose":"stays"}'Get a Circle
GET /v1/circle/{circle_id}
Returns a single circle together with its members. Returns 404 if the circle does not exist or the user cannot access it.
| Field | Type | Required | Description |
|---|---|---|---|
circle_id | string (path) | yes | Circle UUID. |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/circle/{circle_id}Sandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X GET 'https://cloud.vanitypass.com/v1/circle/{circle_id}' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \Delete a Circle
DELETE /v1/circle/{circle_id}
Soft-deletes a circle. The record is retained for audit but no longer appears in active listings. No request body.
| Field | Type | Required | Description |
|---|---|---|---|
circle_id | string (path) | yes | Circle UUID. |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/circle/{circle_id}Sandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X DELETE 'https://cloud.vanitypass.com/v1/circle/{circle_id}' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \