Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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

​
Authentication

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.

​
Pagination

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

​
Rate Limiting

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