Get a document
GET/v1/documents/{documentId}
Returns one document — also a pending one, so you can check an upload you started. Its bytes are at GET /documents/{documentId}/download.
Permissions: documents:read · Kind: read · Cost: 1 unit
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
documentId |
uuid | yes |
Query parameters
None.
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
object |
"document" | yes | |
id |
uuid | yes | |
tripId |
uuid | yes | |
folderId |
uuid | null | yes | The folder it is filed in; null = loose (in no folder). |
name |
string | yes | |
mimeType |
string | yes | |
byteSize |
integer | yes | ≥ 0 |
status |
"pending" | "ready" | yes | pending: reserved, the upload is not complete — never listed. ready: a document. |
visibility |
"staff" | "traveler" | yes | staff: internal, only the agency sees it. traveler: released to the trip's travelers. |
visibleToTravelersNow |
boolean | yes | Released AND the trip is published: the traveler's app shows it right now. |
visibleAt |
string | null | yes | When it was last released to travelers; null while internal. |
visibleBy |
object | null | yes | |
visibleBy.id |
string | yes | |
visibleBy.name |
string | null | yes | |
uploadedBy |
object | null | yes | |
uploadedBy.id |
string | yes | |
uploadedBy.name |
string | null | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes | |
appUrl |
string | null | yes | The trip's Documents tab in bymundi. |
Errors
Errors are problem details. Besides the refusals described above, any call like this one can return:
invalid_request— Invalid requestunauthorized— Missing or invalid API keyinsufficient_scope— Missing permissionrate_limited— Rate limit reachednot_found— Not found