FAfactorialhr
Ats > CandidateSource

Reads a single Candidate source

Changed on

Reads a single Candidate source

get/api/2026-10-01/resources/ats/candidate_sources/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/ats/candidate_sources/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: recruitment
    • or API key in header x-api-key

Path parameters

idstring required

a list of source identifiers.

Response

OK

idstring required

identifier of the source.

company_idstring required

identifier of the company.

category'job_board' | 'agency_or_external_recruiter' | 'event' | 'social_media' | 'referral' | 'internal' | 'manually_added' | 'organic' | 'system' required

category of the source.

namestring required

name of the source.

labelstring required

Translated label of the source if it is a default one, or name otherwise

Example response

{
  "id": "1",
  "company_id": "1",
  "category": "social_media",
  "name": "manually_added",
  "label": "Manually added"
}

Changes