REST API reference

Tickets, customers, articles and categories over a clean REST API.

REST API reference

Base URL:

https://fbyeoijchofxayzhozwy.supabase.co/functions/v1/public-api-v1/v1

All requests require the x-api-key header. Responses are JSON. List endpoints support page and per_page. A machine-readable spec is available at https://fbyeoijchofxayzhozwy.supabase.co/functions/v1/public-api-v1/v1/openapi.json.

Tickets

  • GET /v1/tickets — list (filter by status, priority, category, customer_email; sort/order).
  • GET /v1/tickets/:id — fetch one with replies.
  • POST /v1/tickets — create a ticket.
  • PUT /v1/tickets/:id — update status, priority, assignee, tags.
  • POST /v1/tickets/:id/reply — add a reply.

Create a ticket

curl -X POST "https://fbyeoijchofxayzhozwy.supabase.co/functions/v1/public-api-v1/v1/tickets" \
  -H "x-api-key: ar_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Cannot log in",
    "body": "I get an error on the login page.",
    "customer_email": "jane@example.com",
    "priority": "high"
  }'

Customers

  • GET /v1/customers — list / filter by email.
  • GET /v1/customers/:id — fetch one with recent tickets.
  • POST /v1/customers — create or upsert by email.
  • GET /v1/customers/:id/tickets — a customer's tickets.

Knowledge base

  • GET /v1/articles — list published articles (filter by category, search).
  • GET /v1/articles/:id — fetch one.
  • GET /v1/articles/search?q=... — full-text search.
  • GET /v1/categories — list categories.

Meta

  • GET /v1/info — workspace + API metadata.
  • GET /v1/openapi.json — OpenAPI 3 spec for codegen.

Errors

Standard HTTP codes: 400 bad request, 401 missing/invalid key, 403 origin/scope denied, 404 not found, 429 rate limited. Errors return { "error": { "message": "...", "code": "..." } }.