Alfa

Exports

Start exporting the organisation's candidates to an Excel workbook

POST/v1/exports/candidates

The workbook is built in the background. The response carries its `queueId`; read its status from `GET /v1/exports/candidates/{exportId}`.

Requires the session token of a signed-in Alfa user as a bearer token.

Request body

  • jobStatus"all" | "live" | "closed" | "draft"
  • tagsstring[]
  • jobIdinteger | null
  • createdAfterstring | null
  • createdBeforestring | null
  • columnsstring[]

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details