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 documentsRetrieve a job url - DEPRECATEDDelete a jobRetrieve a job checklistComplete info gathering for a job

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeApprove a job scope changeReject a job scope change

Job TemplatesThe Job Template ResourceRetrieve available job templates

Service PackagesThe Service Package ResourceRetrieve a list of your service packagesSubmit service package answers

DocumentsThe Document ResourceCreate a documentGet a documentDownload a document

Document TypesThe Document Type ResourceList document types

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

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.

•

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

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 button as well as the session expired page. See details below.

Portal View

type

•

string

The portal view type.

job_details - The portal view type to generate a Magic Link for the job details page.

Note

When the job is under construction and the given user ID has permission to create jobs, it redirects to the onboarding page and the hide_navbar is ignored.

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

Return Options

url

•

string

The URL to return the user to.

action_label

•

string

The label to display on the back button.

Sample Request

Copied
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" } }'

Response

url

•

string

The Magic Link's URL.

Sample Response

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

Last updated on September 10, 2024