Developers

API reference

REST under /api/v1. Authenticate with Bearer API keys on Growth and Scale plans. Machine-readable OpenAPI is always available at the JSON endpoint.

Base URL https://app.otter.diy/api/v1

Auth Authorization: Bearer <api_key>

Keys Create in Settings → API keys. Each key is bound to one workspace, stored hashed, and shown once. No tenant header needed.

Spec: /api/v1/openapi.json · MCP install

get/api/v1

API root / capability discovery

get/api/v1/jobs

List jobs

Returns jobs for the authenticated tenant (DB-backed). Requires Growth+.

get/api/v1/jobs/{id}

Get a job

get/api/v1/candidates

List or search candidates

Pass `q` for free-text search (name, email, headline, company). DB-backed. Requires Growth+.

get/api/v1/candidates/{id}

Get a candidate

get/api/v1/applications

List applications

get/api/v1/applications/{id}

Get an application

get/api/v1/interviews

List interviews

get/api/v1/notes

List notes

post/api/v1/notes

Create a note

Attach a note to a candidate (optionally tied to an application). Requires a read & write key. The note is authored by the key's creator and appears on the candidate timeline.

Errors

Errors return { "error": string, "code": string } with HTTP status 400 / 401 / 403 / 404 / 503. List responses use { data: { items, next_cursor, meta } }.