Get Job Checklist

Query a job's checklist

This endpoint lets you query for the Info Gathering Checklist of your job.

Endpoint

Method	Url
`GET`	`v1.0/jobs/{job_id}/checklist`

Url Parameters

job_id

•

guid

The job's ID.

Sample Request

Copied
1curl -X GET 'https://api.worklayer.com/v1.0/jobs/499d692d-67aa-4127-a45c-b9e27f54afad/checklist' \
2-H 'Authorization: Bearer {token}'

Response

name

•

string

The name of the supporting item.

short_description

•

string

A short description of the supporting item.

preview_url

•

string

An optional URL linking to a downloadable/viewable resource to provide as a sample of what is being asked for.

required

•

bool

Whether the item is required before proceeding from the info gathering stage.

ad_hoc

•

bool

Whether the document was specifically requested by the provider.

completed

•

bool

Whether the item is considered completed.

input

•

object

Specification for collecting a supporting item and its corresponding value. Currently, only the collection of documents with a specific document type is supported.

Sample Response

Copied
1{
2  "sections": [{
3    "id": "PERSONAL_INFORMATION",
4     "name": "Personal information",
5     "requested_supporting_items": [{
6       "id": "fd4b72f5-cd5e-44bb-aa31-daef92722616",
7       "name": "W-2",
8       "short_description": "Salary from employer",
9       "preview_url": "https://www.irs.gov/pub/irs-pdf/fw2.pdf",
10       "required": false,
11       "ad_hoc": false,
12       "completed": true,
13       "update_time": "2023-09-29T12:15:00Z",
14       "input": {
15         "document": {
16           "document_type_id": "W_2"
17         }
18       }
19     }]
20  }
21}

The input object is a Discriminated Union, with the sole child object key name acting as the discriminator, in this case, document. Additional union member types will be supported in the future.

Last updated on October 15, 2024