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

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 document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messages

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

Listing Messages

List messages belonging to your job in the workspace.

The list messages endpoint allows you to retrieve a paginated list of the messages for a your job in your workspace.

Endpoint

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

Request Parameters

page_size

•

number

The page size for search result pagination. If not provided, the service will default to 50 items.

page_token

•

string

The page to fetch. If any, this would be the next_page_token value returned from the previous request.

Sample Request

Copied
1curl -X GET 'https://api.worklayer.com/v1.0/jobs/a439ddfa-6ba4-4b38-8cf0-5d09db1a0af4/messages' \
2-H 'Authorization: Bearer {token}'

Response

data

•

list

The messages belonging to that job. See the message reference page.

next_page_token

•

string

The pagination token to retrieve the next page of results. If the value is "", it means no further results for the request.

Sample Response

Copied
1{
2  "data": [
3    {
4      "id": "873eb165-3a9f-443d-b273-b72a1d9fa2da",
5      "sender_user_id": "a6e5ea2f-7d96-4852-9f46-2383dfd572f7",
6      "create_time": "2022-04-11T15:18:00.701Z",
7      "text": "Hello, this is a message.",
8    },
9    {
10      "id": "dd313afe-8348-4f25-b327-1faf2244710a",
11      "sender_user_id": "781350c1-14cd-4790-88ef-841af4097aad",
12      "create_time": "2020-07-10T17:49:00.223Z",
13      "text": "This is another message.", 
14    },
15  ],
16  "next_page_token": "c3RyaW5nL3dvcmtzcGFjZV9tZW1iZXIudXNlcl9pZC9hc2MvbG9jYWwlN0NlMmNlMTM0ZC03NmYyLTVhNzctOWQ2Yy05MDY2NjVkM2VlNTQ="
17}

Errors

Forbidden: API Client cannot list workspace members.
Unauthorized: API Client does not have valid credentials.
NotFound: No messages found for the given job ID.
BadRequest: Either the filter that was provided is in an incorrect format, or there was a malformed request.

Last updated on July 15, 2025

Privacy Policy Terms & Conditions© 2025 Taxfyle