API reference
Read your Furmissions data from your own tools with an API key.
Getting a key
- Member keys: Settings → API keys. A member key acts as you, and only sees what you could see on the site.
- Server keys: made by staff in Staff → System → API keys, for the site’s own systems.
- Each key has its own permissions, rate limit and expiry, and can be revoked at any time. Keys are shown once: keep them secret and never put them in a public website or app.
Sending requests
Base address: https://furmissions.com/api/v1. Send the key in the Authorization header. Responses are JSON; lists are paginated with data, links and meta.
curl https://furmissions.com/api/v1/me \
-H "Authorization: Bearer fmk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Accept: application/json"| Status | Meaning |
|---|---|
| 401 | No key, wrong key, or the key was revoked, expired or used from a blocked IP address. |
| 403 | The key is missing a permission, or is the wrong kind (member or server) for this address. |
| 404 | Not found, or not yours. |
| 422 | A filter or field isn’t valid; the response says which. |
| 429 | Too many requests. Wait for the Retry-After seconds. X-RateLimit-Limit and X-RateLimit-Remaining show where you are. |
Member endpoints
| Request | Permission | What it returns |
|---|---|---|
| GET /me | profile:read | Your profile, Premium status and upload allowance. |
| GET /orders | orders:read | Your purchases and your stores’ orders. Filters: role=buyer|seller, status, per_page (max 100). |
| GET /orders/{uuid} | orders:read | One order you’re part of. |
| GET /listings | listings:read | Listings in stores you manage. Filters: status, per_page. |
| PATCH /listings/{id} | listings:write | Pause or resume (status: active|paused) or set stock (number or null). |
| GET /conversations | messages:read | Your buyer and seller chats, newest first. |
| GET /notifications | notifications:read | Your notifications. |
| GET /credits | credits:read | Credit balances and the last 50 changes. |
All permissions
- profile:read: See your profile, Premium status and upload allowance
- orders:read: See your purchases and your stores’ orders
- messages:read: See your buyer and seller conversations
- notifications:read: See your notifications
- credits:read: See your credit balances and history
- listings:read: See your stores’ listings (sellers)
- listings:write: Pause, resume and change stock on your stores’ listings (sellers)
Server endpoints
| Request | Permission | What it returns |
|---|---|---|
| GET /server/health | health:read | Cron, queue and disk health. Returns 200 when healthy and 503 when not, so uptime monitors can watch it. |
| GET /server/stats | stats:read | Sales and growth figures for the last 30 days. |
| GET /server/accounts | accounts:read | Member accounts. Filters: q (name, email or username), per_page. |
| GET /server/accounts/{id} | accounts:read | One account with its stores and credit. |
| GET /server/orders | orders:read-all | Every order. Filters: status, since (date), per_page. |
| GET /server/listings | listings:read-all | Every listing. Filters: status, per_page. |
| GET /server/tickets | tickets:read | Support tickets and disputes. Filters: category, status, per_page. |
All permissions
- health:read: Check cron, queue and disk health (for uptime monitors)
- stats:read: Read sales and growth figures
- accounts:read: Read member accounts (never passwords or secrets)
- orders:read-all: Read every order
- listings:read-all: Read every listing
- tickets:read: Read support tickets and disputes