ConceptsThe Worklayer platformAuthentication

MemberThe Member ResourceCreate a memberRetrieve a list of membersUpdate a member

JobsThe Job ResourceThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProSubmit a jobRetrieve a list of your jobsList job documentsRetrieve a job url - DEPRECATEDDelete a jobRetrieve a job checklistComplete info gathering for a job

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeList consultation service itemsCreate job scope change requestApprove a job scope changeReject a job scope change

Job TemplatesThe Job Template ResourceRetrieve available job templates

Service PackagesThe Service Package ResourceRetrieve a list of your service packagesSubmit service package answers

Personal ProfilesThe Personal Profile ResourceRetrieve a personal profileSave a personal profileProvide a personal profile to a jobRetrieve a personal profile for a job

Spousal ProfilesThe Spousal Profile ResourceRetrieve a spousal profileSave a spousal profileProvide a spousal profile to a jobRetrieve a spousal profile for a job

Dependent ProfilesThe Dependent Profile ResourceRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a document

Document TypesThe Document Type ResourceList document types

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

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

sections

•

array

An array of sections, each containing a list of requested supporting items.

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      "id": "443013e3-4c1e-4fb1-b183-446e0f910171",
21      "name": "Personal information",
22      "short_description": "To streamline the process, please provide your essential personal information. Your data will be handled securely and used only for processing your request.",
23      "required": true,
24      "ad_hoc": false,
25      "completed": true,
26      "update_time": "2023-09-30T13:41:00Z",
27      "input": {
28        "personal_info": {
29          "profile_id": "150e7f40-1158-4fe6-864c-6cce3879cd34",
30          "profile_version": 1
31        }
32      }
33    }, {
34      "id": "7a9e1d5b-8f32-4c9a-b95e-9c3a7d518e42",
35      "name": "Personal tax refund method",
36      "short_description": "Get the payout you deserve, your way.",
37      "required": true,
38      "ad_hoc": false,
39      "completed": true,
40      "update_time": "2023-09-30T14:22:00Z",
41      "input": {
42        "personal_refund_method": {
43          "refund_method_id": "550e8400-e29b-41d4-a716-446655440000",
44          "refund_method_version": 1
45        }
46      }
47    }]
48  }
49}

The input object is a Discriminated Union, with the sole child object key name acting as the discriminator; in this case, document and personal_info. See the Supporting item section for more information.

Section

•

string

ID of the section.

name

•

string

The display name of the section.

requested_supporting_items

•

array

An array of supporting items, such as specific documents or certain pieces of information. These are items that are requested from the client in order for the Pro to perform the work.

Supporting item

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. Must contain exactly one property, which can be one of:

document, indicating that a document is requested. Upload a document of the requested type to complete the item.
personal_info, indicating that the personal information of the client is requested. Save and provide a personal profile for the client to complete the item.
spousal_info, indicating that the spousal information of the client is requested. Save and provide a spousal profile to complete the item.
dependents_info, indicating that dependent information is requested. Create and provide one or more dependent profiles to complete the item.
business_info, indicating that business information is requested. Create and provide a business profile to complete the item.
personal_refund_method, indicating that personal refund method information is requested. Create and provide a personal refund method to complete the item.
business_refund_method, indicating that business refund method information is requested. Create and provide a business refund method to complete the item.

An array of provided dependent profiles, each containing:

profile_id (string): The ID of the dependent profile
profile_version (number): The version of the dependent profile

Business info

profile_id

•

string

The ID of the business profile when provided, null otherwise.

profile_version

•

number

The version of the business profile when provided, null otherwise.

Last updated on November 1, 2024