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 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 jobRequest cancellationRequest reopen

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

Retrieve a specific member by their external ID.

The get member endpoint allows you to retrieve a specific member from your workspace by their external ID.

Endpoint

Method	Url
`GET`	`/v1.0/members/external-id:{external_id}`

Path Parameters

external_id

•

string

required

The unique identifier from your system to retrieve the member.

Sample Request

Copied
1curl -X GET 'https://api.worklayer.com/v1.0/members/external-id:2ee90898-6b84-4139-8560-d76b40c914ec' \
2-H 'Authorization: Bearer {token}'

Response

An instance of member resource.

Sample Response

Copied
1{
2    "email": "tony@stark.com",
3    "user_id": "a6e5ea2f-7d96-4852-9f46-2383dfd572f7",
4    "external_id": "2ee90898-6b84-4139-8560-d76b40c914ec",
5    "create_time": "2022-04-11T15:18:00.701Z",
6    "update_time": "2022-04-11T15:18:00.701Z"
7}

Errors

Forbidden: API client does not have permission to view workspace members.
Unauthorized: API client does not have valid credentials.
NotFound: The specified member was not found in the workspace.
BadRequest: The external ID provided is not in a valid format.

Last updated on December 18, 2025

Privacy Policy Terms & Conditions© 2026 Taxfyle