curl --request GET \
--url https://api.example.com/api/projects/{projectId}/documents/{documentId} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"path": "<string>",
"name": "<string>",
"type": "f",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {},
"contentType": "<string>",
"size": 123,
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedAt": "<string>",
"publishedBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"published": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"content": "<unknown>",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "<string>",
"versions": [
"<unknown>"
],
"releases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>"
}
]
},
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"content": "<unknown>",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "<string>",
"versions": [
"<unknown>"
],
"releases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>"
}
]
}
],
"changeRequests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"status": "<string>",
"createdAt": "<string>"
}
],
"view": {
"description": "<string>",
"permissions": {}
},
"updatedAt": "<string>",
"deletedAt": "<string>"
}Retrieve a single document by ID with its latest version and content.
curl --request GET \
--url https://api.example.com/api/projects/{projectId}/documents/{documentId} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"path": "<string>",
"name": "<string>",
"type": "f",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {},
"contentType": "<string>",
"size": 123,
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedAt": "<string>",
"publishedBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"published": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"content": "<unknown>",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "<string>",
"versions": [
"<unknown>"
],
"releases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>"
}
]
},
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"content": "<unknown>",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "<string>",
"versions": [
"<unknown>"
],
"releases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>"
}
]
}
],
"changeRequests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"status": "<string>",
"createdAt": "<string>"
}
],
"view": {
"description": "<string>",
"permissions": {}
},
"updatedAt": "<string>",
"deletedAt": "<string>"
}Personal access token is obtained through your profile
Document unique identifier
Project unique identifier
Include deleted documents
true, false, True, False, TRUE, FALSE Document with full details
Document with full details
Document unique identifier
Materialized lowercase path based on the name
Materialized path based on the name
Document name
Document type (file, directory, or external file)
f, d, e Project ID
Document metadata
Show child attributes
Content MIME type
Document size in bytes
Parent document ID
Currently published version ID
Publication timestamp
User who published the document
Show child attributes
Published version details
Show child attributes
Document versions
Show child attributes
Pending change requests
Show child attributes
Document view configuration
Show child attributes
Last update timestamp
Deletion timestamp if soft deleted
Was this page helpful?