Getting Started

The Spott API provides programmatic access to your recruitment data.

Base URL

All API requests should be made to:

https://api.gospott.com

Private API requests must include an x-api-key header. You can generate API keys from Settings → API Keys in your Spott dashboard.

curl https://api.gospott.com/candidates \
  -H 'x-api-key: your_api_key'

Public API endpoints do not require authentication. All public requests are scoped to a tenant via the publicTenantSlug path parameter.

List endpoints support cursor-based pagination. Use the cursor parameter from the response to fetch subsequent pages.

API endpoints are rate-limited. If you exceed the rate limit, you will receive a 429 Too Many Requests response.