Rolefy

API reference / Applications

Retrieve an application

GET/v1/applications/{id}

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

The full application: the candidate's details, cover letter, resume and other documents (as signed download links that expire after 24 hours), and their answers to your screening questions. Only applications to jobs your application created can be read.

Path parameters

  • idstring · uuidpathrequired

    The application's id.

Responses

  • 200The application
    Response fields
    • dataApplication
      • idstring · uuid
      • job_idstring · uuid
      • external_job_idstringnullable
      • statusstring

        Allowed values:submittedreviewingshortlistedinterviewofferedhiredrejected

      • created_atstring · date-time
      • candidateobject
        • first_namestring
        • last_namestring
        • emailstring
        • headlinestringnullable
        • location_citystringnullable
        • location_countrystringnullable
        • work_rightsstringnullable
        • availabilitystringnullable
        • linkedin_urlstringnullable
        • portfolio_urlstringnullable
        • github_urlstringnullable
        • skillsarray of string
      • cover_letterstringnullable
      • resumeobjectnullable
        • file_namestring
        • urlstring

          A signed link. It stops working after 24 hours, so download the file straight away or fetch the application again for a fresh link.

        • url_expires_atstring · date-time
      • documentsarray of objects
        • document_type_namestringnullable
        • file_namestring
        • urlstring
        • url_expires_atstring · date-time
      • questionnaire_answersarray of objects
        • question_textstring
        • question_typestring
        • answer_textstringnullable
        • answer_optionsarray of stringnullable
  • 404Not found (not_found)
    Example response
    {
  "error": {
    "code": "not_found",
    "message": "Not found (`not_found`)."
  }
}