FoyerDevelopers

Public API · Reference

HTTP responses

What the API returns, and what each status means.

Successful responses are 200 with a JSON body. Errors carry a JSON body describing what went wrong.

  • 200 — the request succeeded
  • 400 — a query parameter failed validation
  • 401 — the API key is missing, malformed, revoked or expired
  • 403 — the key's role or module scope does not cover this resource, or the tenant is on a plan below AI
  • 404 — the resource does not exist, or belongs to another tenant
  • 429 — the API key has exceeded its rate limit
  • 500 — an unexpected server error