Alfa

API reference · v1

Alfa API

The API the Alfa app is built on: 263 operations across jobs, candidates, sourcing and Lisa. Every operation is versioned under /v1, described by an OpenAPI 3.1 document and validated against the same schemas.

Download the OpenAPI document

Connect your ATS with the Alfa API

To connect an applicant tracking system, call the Alfa API from your server with an API key: send Alfa your jobs, and receive every candidate Alfa screens or sources for them by webhook. It works for a company connecting its own ATS and for ATS platforms serving many client companies.

Start the quickstartRead the Alfa API overview

Base URL

  • https://api.welovealfa.com/v1 Production
  • https://staging-api.welovealfa.com/v1 Staging
  • https://dev-api.welovealfa.com/v1 Development

Authentication

Send the session token of a signed-in Alfa user in the Authorization header as Bearer <token>. Operations under /v1/public need no token. Every request acts as that user, within their organization. Operations under /v1/integration take an Alfa API key instead.

Requests

Bodies are JSON. Ids travel in the path, filters in the query string. An unknown query parameter or body field is rejected rather than ignored, so a typo fails loudly. PATCH changes only the fields you send.

Errors

Every error is a problem details object (RFC 9457) with the media type application/problem+json. Match on code; read detail for a message you can show; a validation failure lists each invalid field in errors. See every error code.

422 response
{
  "type": "https://welovealfa.com/developers/errors/validation-failed",
  "title": "Request validation failed",
  "status": 422,
  "detail": "The request is invalid.",
  "code": "validation_failed",
  "errors": [
    {
      "pointer": "/body/title",
      "detail": "Too small",
      "code": "too_small"
    }
  ]
}

Versioning

Changes within /v1 are additive: new operations, new optional fields and new response fields. A breaking change ships as a new operation. An operation due for removal is marked deprecated here and answers with Deprecation and Sunset headers first.

Resources