Docs

Access

Every access endpoint, with its scope, parameters, a request and a response.

POST /access/evaluate

Which locks a customer (by tags, sign-in and codes) would pass

Scope access:read Returns 200

ParameterInTypeDescription
dry_run query true true: validate and return the would-be result; nothing is saved
wait query true true: wait up to 20 s until the change is live at checkout
Idempotency-Key header string Retrying with the same key never applies the write twice (kept 24 h)
Request body (3 fields)
FieldTypeDescription
customerrequired object
codes string[]
lock_ids string[]

Request

curl -X POST "https://app.shopbird.app/api/v1/access/evaluate" \
  -H "Authorization: Bearer sb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "customer": {
    "tags": [],
    "signed_in": false,
    "created_at": "2026-11-01T09:00:00Z"
  },
  "codes": [
    "string"
  ],
  "lock_ids": [
    "string"
  ]
}'

Response 200

{
  "data": [
    {
      "lock_id": "clx8k2v1a0000qs08h3f2b9de",
      "name": "VIP early access",
      "access": "open",
      "active": true,
      "code_matched": true
    }
  ],
  "sync_pending": true
}