v1

latestOpenAPI 3.1.02026-07-14801408.6 KB

/candidates/:id/offer

Returns the offer related data of the given candidate. Required scope: r_candidates. Accessible with all token types.

get/candidates/{id}/offer

Path parameters

idstring required

The candidate's id

Response

200

created_atstring

Example response

{
  "candidate": {
    "id": "3a2b35a4",
    "location": "San Diego, California, USA",
    "name": "James Jameson"
  },
  "created_at": "2021-06-10T13:43:40.442Z",
  "document_variables": [
    {
      "document_variable": {
        "name": "Today Date",
        "slug": "today_date"
      },
      "value": {
        "body": "2012-12-10"
      }
    }
  ],
  "documents": [
    {
      "name": "signed-offer.pdf",
      "preview_url": "https://signature/offer/signed-offer.pdf",
      "kind": "offer"
    }
  ]
}