Skip to content

Get Document

Get a document belonging to a job in your workspace.

The get document endpoint allows you to retrieve a document in your workspace.

Endpoint

MethodUrl
GET/v1.0/documents/{document_id}

Url Parameters

document_id
string

The document's id.

Sample Request

Copied
1curl -X GET 'https://api.worklayer.com/v1.0/documents/499d692d-67aa-4127-a45c-b9e27f54afad' \
2-H 'Authorization: Bearer {token}'

Sample Response

Copied
1{
2 "id": "95e6f305-913e-40ad-9c80-ede263670878",
3 "title": "document.txt",
4 "description": "",
5 "create_time": "2022-04-11T15:18:00.701Z",
6 "update_time": "2022-04-11T15:18:00.701Z",
7 "document_type": {
8 "id": "DRAFT_RETURN",
9 "name": "Draft return"
10 }
11}

Errors

  1. Forbidden: API Client does not have permission to create members.
  2. Unauthorized: API Client does not have valid credentials.
  3. BadRequest: Either required properties are missing, or there was a malformed request.
Last updated on October 12, 2022