Skip to content

Retrieve Job URL DEPRECATED

Resource representing a job URL.

The Job URL resource generates a link to send a user directly to the job details in the client portal. Linking to jobs should always be done by obtaining a job link. If your workspace is configured, you can also obtain a signed url to the job's details page. This will allow you to link to the job without requiring the user to login to the client portal.

The job must be submitted to generate the Magic Link.

Endpoints

MethodUrl
POST/v1.0/jobs/{job_id}/job_link

Request Parameters

job_id
guid

The job's id.

user_id
guid

The user id this link is being generated for.

hide_navbar
boolean

Determines the visibility of the navigation bar.

signed_url_session
boolean

Determines if the URL should be signed for a session. Only available if your workspace is configured.

A Signed URL session will allow you to link to the job without requiring the user to login to the client portal.

Signed URLs are only valid for 5 minutes and the Signed URL sessions are only valid for 24 hours.

Only issue a Signed URL for the user that is the owner of the job.

return_options
return_options

Return options allow you to specify details of where to return the user 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.


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/jobs/{job_id}/job_link' \
2-H 'Authorization: Bearer {token}'
3-d '{ "user_id": "user_id_guid", "hide_navbar": true }'

Response

url
string

The Job's URL.

Sample Response

Copied
1{
2 "url": "https://domain/project/job_id?show=login&connection=google&hideNavbar=true"
3}
Last updated on July 25, 2022