Docs

Outbound sourcing

Get a job's sourcing

GET/v1/integration/jobs/{jobId}/sourcing

The sourcing campaigns on a linked Alfa job, whether started through the API or by a recruiter in Alfa, the credits each one charged, and how many sourced candidates Alfa has reported on the job. A job that is not linked, or belongs to another company, is 404. Requires an API key with the `jobs:read` scope.

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

Path parameters

  • jobIdstringrequired

    Alfa's id for the job.

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

  • jobIdintegerrequired

    Alfa's id for the job.

  • sourcedCandidatesintegerrequired

    How many sourced candidates Alfa has reported on the job so far.

  • campaignsobject[]required

    The job's sourcing campaigns, newest first.

    Show fields
    • campaignIdintegerrequired

      Alfa's id for the campaign.

    • requestIdstring | nullrequired

      The `requestId` the campaign was started with, or null for a campaign a recruiter started in Alfa.

    • creditsintegerrequired

      The sourcing credits the campaign charged.

    • status"pending" | "running" | "complete"required

      `pending` until Alfa starts searching, `running` while it finds candidates, then `complete`.

    • startedAtstringrequired

      When the campaign was started.

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