curl --request GET \
--url https://api.poelis.com/v1/public/files \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.poelis.com/v1/public/files"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.poelis.com/v1/public/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"count": 1,
"items": [
{
"content_type": "application/pdf",
"deleted": false,
"description": "Specification document for compressor performance and operating constraints.",
"id": "990e8400-e29b-41d4-a716-446655440000",
"name": "compressor-spec-v3.pdf",
"originalFileName": "compressor-spec-v3.pdf",
"size_bytes": 245612,
"uploadedBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"uploaded_at": "2026-04-01T10:11:12.123Z",
"used_in": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"product_id": "660e8400-e29b-41d4-a716-446655440000",
"target_id": "770e8400-e29b-41d4-a716-446655440000",
"target_type": "item"
}
],
"userTitle": "Compressor specification"
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}List files
Retrieve files by scope.
Scopes
Use exactly one primary scope:
item_idto list files linked to an item (optionally include linked property files)property_idto list files linked to a propertyproduct_idto list files in the product’s workspace (usehas_links=trueto only keep linked files)workspace_idto list files in the workspace
Versioning
version supports:
- Omitted or null: draft
- Integer (for example
5): files as of that version baseline: files as of the product baseline version
For workspace_id scope, version is not supported.
Filtering
Supports name search (q), MIME type (content_type), uploader (uploaded_by), linked/unlinked (has_links), and pagination.
curl --request GET \
--url https://api.poelis.com/v1/public/files \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.poelis.com/v1/public/files"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.poelis.com/v1/public/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"count": 1,
"items": [
{
"content_type": "application/pdf",
"deleted": false,
"description": "Specification document for compressor performance and operating constraints.",
"id": "990e8400-e29b-41d4-a716-446655440000",
"name": "compressor-spec-v3.pdf",
"originalFileName": "compressor-spec-v3.pdf",
"size_bytes": 245612,
"uploadedBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"uploaded_at": "2026-04-01T10:11:12.123Z",
"used_in": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"product_id": "660e8400-e29b-41d4-a716-446655440000",
"target_id": "770e8400-e29b-41d4-a716-446655440000",
"target_type": "item"
}
],
"userTitle": "Compressor specification"
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}Authorizations
Enter your API key. Example: Bearer poelis_api_...
Query Parameters
Workspace ID scope
"550e8400-e29b-41d4-a716-446655440000"
Product ID scope
"660e8400-e29b-41d4-a716-446655440000"
Item ID scope
"770e8400-e29b-41d4-a716-446655440000"
Property ID scope
"880e8400-e29b-41d4-a716-446655440000"
Product version number (integer) or 'baseline'. Omit or null for draft.
null
When item_id is provided, include files linked to the item's properties.
Optional search query to filter results.
Filter by exact MIME type.
Filter by uploader user ID.
Filter by linked/unlinked files.
Include soft-deleted files.
Maximum number of items to return per page. Must be between 1 and 200.
1 <= x <= 200Number of items to skip from the beginning of the result set. Used for pagination.
x >= 0