API Reference

Gets a single employee document together with download and signature status metadata.

get
https://example.com/wep/companies//employees//documents/

Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute.

The route must identify a document that belongs to the specified employee within the specified company. Employee callers can retrieve only their own allowed documents.

The response includes a file token that API consumers can use with file-download endpoints and signature status flags for supported document types.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Identifier of the company that employs the employee.

int32
required

Identifier of the employee who owns the document.

int32
required

Identifier of the employee document to retrieve.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago