Skip to content

API Documentation

ConceptsThe Worklayer platformAuthenticationRate LimitsError handling

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 ResourceGet a consultationList consultations

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

Retrieve Dashboard Magic Link

Resource representing a Magic Link for Dashboard.

The Magic Link resource generates a link to send a user directly to the dashboard in the client portal. This will allow you to link to the dashboard without requiring the user to login to the client portal.

Magic Links are only valid for 5 minutes and the Magic Link sessions are only valid for 24 hours.

Endpoints

Method	Url
`POST`	`/v1.0/magic-link`

Request Parameters

user_id

•

guid

The user ID this magic link is being generated for.

email

•

string

The email this magic link is being generated for. A new email will result in a new member being created.

Note

Only an email or user_id is required, not both.

portal_view

•

portal_view

required

Allows you to specify the portal view for the magic link that is going to be generated. See details below.

return_options

•

return_options

Allows you to specify details about where to return the user to after they have completed actions in the client portal. This affects the portal's back button as well as the session expired page. See details below.

allowed_legend_ids

•

array

Allows you to specify a list of legend IDs that the user can create jobs from. Omitting this field will result in the user being able to create jobs from all legends that are enabled for job creation.

Portal View

type

•

string

required

The portal view type.

dashboard - The portal view type to generate a Magic Link for the dashboard page.

Return Options

url

•

string

required

The URL to return the user to.

action_label

•

string

The label to display on the back button.

Sample Request

bashCopied
1curl -X POST 'https://api.worklayer.com/v1.0/magic-link' \
2-H 'Authorization: Bearer {token}'
3-d '{ "user_id": "user_id_guid", "portal_view": { "type": "dashboard" }, "allowed_legend_ids":  ["legend_id"] }'

Response

url

•

string

The Magic Link's URL.

Sample Response

jsonCopied
1{
2  "url": "https://domain/__session/{payload}?s={signature}"
3}

Last updated on September 10, 2024

Privacy Policy Terms & Conditions© 2026 Taxfyle