Skip to main content

Authentication

Every request to the Moxie Public API must include your workspace API key in the X-API-KEY header.

curl https://api.withmoxie.com/public/action/clients/list \
-H "X-API-KEY: your_api_key_here"
HeaderRequiredDescription
X-API-KEYYesYour workspace API key. Identifies the Moxie account (workspace) all actions run against.
X-Event-OriginNoOptional origin hint sent by some integration surfaces. Safe to omit for direct API calls.

The API key maps to a single workspace (ApiConnection). Every record you read or create is scoped to that workspace — you cannot address another account with the same key.

Keep your key secret

The API key grants full read/write access to the workspace. Store it as a server-side secret. Do not embed it in client-side code, mobile apps, or public repositories.

Errors

Standard HTTP status codes are returned. A missing or invalid X-API-KEY returns 401/403. Malformed request bodies return 400. Endpoints that resolve records by name return an error when the named record cannot be found (unless the endpoint documents a create* flag that creates it).