Skip to content

API Documentation

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 scopeApprove 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

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

Create a Job from a Job Template

Create an under-construction job from a job template.

This endpoint lets you create a job based on a job template for a member in your workspace. It will create jobs in the UNDER_CONSTRUCTION status.

Endpoint

Method	Url
`POST`	`/v1.0/jobs`

Request Payload

job_template_id

•

guid

The job template id.

owner_user_id

•

guid

The user id for whom we wish to create the job.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs' \
2-H 'Authorization: Bearer {token}'
3-d '{ "owner_user_id": "user_id_guid", "job_template_id": "id_guid" }'

Response

A job belonging to your workspace. See the job reference page

Sample Response

Copied
1{
2  "id": "499d692d-67aa-4127-a45c-b9e27f54afad",
3  "short_id": "TWQXJWMABW8",
4  "name": "Name from service package",
5  "description": "Tony Stark | 2021 | 1040",
6  "status": "UNDER_CONSTRUCTION",
7  "create_time": "2021-04-28T13:45:25.781Z",
8  "update_time": "2021-04-28T13:52:27.379Z",
9  "transmit_time": null,
10  "deadline_time": null,
11  "total_amount": 10,
12  "members": [
13    {
14      "role": "CHAMPION",
15      "type": "CLIENT",
16      "user_id": "a4feef24-00da-4340-8b7c-a532e0607fdd",
17      "given_name": "Tony",
18      "family_name": "Stark",
19      "display_name": "Tony Stark"
20    }
21  ]
22}

Next steps

Last updated on November 22, 2022

Privacy Policy Terms & Conditions© 2024 Taxfyle