Sign in
Jobs

Get a job worksheet

Retrieve the details of a single job worksheet (required scope jobs:read)

get/v1/jobs/{jobId}/worksheets/{worksheetId}

Path parameters

jobIdinteger required

The unique identifier of the job stock

worksheetIdinteger required

The unique identifier of the worksheet

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier for the worksheet associated with the job

namestring

The name of the worksheet associated with the job

linkType'linkedToJob' | 'branchedFromWorksheetQuestion'

The type of link the worksheet has to the job. Worksheet question can have conditional branching which allows different worksheets to be linked based on answers given.<p>Possible values:</p><ul><li><b>linkedToJob</b>: The worksheet is linked directly to the job</li><li><b>branchedFromWorksheetQuestion</b>: The worksheet is branched from a worksheet question</li></ul>

Example response

{
  "id": 1234,
  "name": "Worksheet Example Name",
  "linkType": "linkedToJob"
}