Rolefy

API reference / Jobs

Retrieve a job

GET/v1/jobs/{id}

Needs a bearer access token with the jobs.read scope. How authentication works

One of your jobs, by Rolefy's id.

Path parameters

  • idstring · uuidpathrequired

    The job's id.

Responses

  • 200The job
    Response fields
    • dataJob
      • idstring · uuid
      • external_job_idstringnullable

        Your own id for this job.

      • titlestring
      • descriptionstring
      • job_typestringnullable
      • work_modelstringnullable
      • experience_levelstringnullable
      • category_idstring · uuidnullable
      • citystringnullable
      • statestringnullable
      • countrystring
      • salary_minnumbernullable
      • salary_maxnumbernullable
      • salary_currencystring
      • salary_periodstring
      • statusstring

        You can set draft, active and closed. The others are set by Rolefy.

        Allowed values:draftpending_approvalactiveexpiredclosedrejectedtaken_down

      • expires_atstring · datenullable
      • applications_countinteger
      • public_urlstringnullable

        The job's page on Rolefy. Null for sandbox jobs.

      • created_atstring · date-time
      • updated_atstring · date-time
  • 404Not found (not_found)
    Example response
    {
  "error": {
    "code": "not_found",
    "message": "Not found (`not_found`)."
  }
}