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 ProAssign a supporting clientRemove a supporting clientSubmit 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 NotesThe Job Note ResourceCreate a job noteGet a job noteList job notes

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 embeddingPortal translations

GuidesFilteringPostman Collection

Get Unread Count

Get the unread message count for a member across all conversations.

The get unread count endpoint allows you to retrieve the unread message count for a specific member across all conversations in your workspace. Each item in the response includes the job ID, unread count, and information about the latest message.

Endpoint

Method	Url
`GET`	`/v1.0/members/{user_id}/unread_count`

Path Parameters

user_id

•

UUID

required

The member's user ID to query unread message counts for.

Query Parameters

limit

•

number

The maximum number of conversations to return. If not provided, the service will default to 1000 conversations.

Sample Request

bashCopied
1curl -X GET 'https://api.worklayer.com/v1.0/members/a6e5ea2f-7d96-4852-9f46-2383dfd572f7/unread_count?limit=100' \
2-H 'Authorization: Bearer {token}'

Response

data

•

list

An array of unread message count objects for each job.

job_id

•

UUID

The unique identifier for the job.

unread_count

•

number

The number of unread messages for this job.

latest_message_id

•

UUID

The unique identifier of the latest message.

latest_message_time

•

timestamp

The timestamp when the latest message was created.

next_page_token

•

string or null

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

Sample Response

jsonCopied
1{
2  "data": [
3    {
4      "job_id": "9a8f5969-20f7-4581-9a3a-1a41f9d4f7f4",
5      "unread_count": 2,
6      "latest_message_id": "873eb165-3a9f-443d-b273-b72a1d9fa2da",
7      "latest_message_time": "2025-11-03T21:22:33.266Z"
8    },
9    {
10      "job_id": "a8020c89-d878-4e5b-b7dc-409118077d63",
11      "unread_count": 2,
12      "latest_message_id": "dd313afe-8348-4f25-b327-1faf2244710a",
13      "latest_message_time": "2025-11-03T21:15:49.588Z"
14    },
15    {
16      "job_id": "1546f8d7-4b8c-4aeb-b568-c4d8ecc27cbc",
17      "unread_count": 1,
18      "latest_message_id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
19      "latest_message_time": "2025-11-03T21:13:48.879Z"
20    }
21  ],
22  "next_page_token": null
23}

Errors

Forbidden: API Client does not have permission to access this member's unread message count.
Unauthorized: API Client does not have valid credentials.
NotFound: The unread message count was not found or the workspace was not found.
BadRequest: Either the user_id is in an incorrect format, or there was a malformed request.

Last updated on November 7, 2025

Privacy Policy Terms & Conditions© 2026 Taxfyle