Skip to content

API Documentation

ConceptsThe Worklayer platformAuthenticationRate Limits

MemberThe Member ResourceCreate a memberRetrieve a memberRetrieve a member by external IDRetrieve a list of membersUpdate a memberAccept terms for a member

JobsThe Job ResourceRetrieve a job by short IDThe 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 documentsDelete a jobRetrieve a job checklistComplete info gathering for a jobRequest cancellationRequest reopen

Relationship ManagerRelationship Manager ResourceRetrieve a job relationship manager

Job ProgressionsApprove a draftReject a draftMark job as ready to file

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

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 ResourceList dependent profilesRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileDelist a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceList business profilesCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobDelist a business profileProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceList tax refund methodsCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodDelist a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a documentDelete a document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messagesGet unread count

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob DetailsWaitlist

PortalPortal embedding

GuidesFilteringPostman Collection

Retrieve a Job by Short ID

Retrieve a specific job using its human-readable short ID.

This endpoint allows you to retrieve a specific job by its short_id — the human-readable identifier (for example, 7GRK4ERKFLL) shown on the job. Use this when you have a job's short ID rather than its id (GUID). To retrieve a job by its id, see the Job Resource page.

Note the literal getByShortId: prefix in the path, followed by the short ID.

Endpoint

Method	Url
`GET`	`/v1.0/jobs/getByShortId:{short_id}`

Path Parameters

short_id

•

string

required

The short ID of the job to retrieve.

Sample Request

bashCopied
1curl -X GET 'https://api.worklayer.com/v1.0/jobs/getByShortId:7GRK4ERKFLL' \
2-H 'Authorization: Bearer {token}'

Response

An instance of the job resource.

Sample Response

jsonCopied
1{
2  "id": "a9749189-c82b-488b-a448-8f74c3d254e0",
3  "short_id": "7GRK4ERKFLL",
4  "name": null,
5  "description": "Tony Stark | 2021 | 1040",
6  "workspace_id": "91",
7  "status": "CLAIMED",
8  "create_time": "2021-06-08T17:38:41.818Z",
9  "update_time": "2022-05-18T18:35:30.136Z",
10  "transmit_time": "2022-05-18T18:35:29.131Z",
11  "deadline_time": null,
12  "total_amount": 199,
13  "members": [
14    // members omitted here for brevity
15  ]
16}

Errors

Forbidden: API client does not have permission to view this job.
Unauthorized: API client does not have valid credentials.
NotFound: No job with the specified short ID was found in the workspace.
BadRequest: The short ID provided is not in a valid format.

Last updated on June 23, 2026

Privacy Policy Terms & Conditions© 2026 Taxfyle