Alfa

Jobs

List linked Alfa jobs

GET/v1/integration/jobs/page

The Alfa jobs a recruiter has linked to one of your ATS jobs, newest first. Requires an API key with the `jobs:read` scope.

Requires an Alfa API key as a bearer token. How API keys work

Query parameters

  • limitstring

    How many results to return, from 1 to 100. Defaults to 25.

  • cursorstring

    The `nextCursor` of the previous page. Leave it out for the first page.

    at least 1 characters · at most 2048 characters

  • externalJobIdstring

    Only jobs linked to this ATS job.

    at least 1 characters · at most 200 characters

Headers

  • Alfa-Company-Idstring

    The Company ID of the company to act for. Required with a platform key, and that company must have authorized your platform; a company key acts for its own company and can leave it out.

Response body

  • dataobject[]required

    The results on this page.

    Show fields
    • jobIdintegerrequired

      Alfa's id for the job.

    • externalJobIdstringrequired

      The ATS job the Alfa job is linked to.

    • titlestring | nullrequired

      The Alfa job title.

    • statusstringrequired

      The Alfa job status: `draft`, `live`, `published`, `paused` or `closed`.

    • applyUrlstringrequired

      The public page where candidates apply.

    • screeningQuestionsobject[]required

      The job's screening questions. Send answers to them with applicant intake.

      Show fields
      • questionstringrequired

        The question, as `screeningAnswers` must quote it.

      • typestring | nullrequired

        The answer type: `boolean`, `number`, `text` or `choice`.

      • mandatorybooleanrequired

        Whether the job marks the question as required.

  • nextCursorstring | nullrequired

    Pass as `cursor` to read the next page; null on the last page.

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