Getting started

The Spoks Public API is a single REST API over HTTPS that returns JSON. Endpoints are grouped by resource in the sidebar.

Base URL

https://api.spoks.com

Your first request

Nearly every request needs an API key, sent in the x-api-key header. Confirm the API is reachable and your key works with the authorization endpoint:

curl https://api.spoks.com/authorization \
  -H "x-api-key: YOUR_API_KEY"

A successful response returns the workspace the key is scoped to:

{ "status": "OK", "feed": { "id": "9b2e6c1e-...", "name": "My workspace" }, "permissions": { "contacts": "read-only" } }

A missing or invalid key returns 403, and requests count against your key's rate limit.

Next steps

• Authentication — how credentials work.
• API basics — base URL, formats and limits.
• Pagination & filtering — working with list endpoints.