Skip to main content
GET
/
v1
/
public
/
files
List files
curl --request GET \
  --url https://api.poelis.com/v1/public/files \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "items": [
    {
      "content_type": "application/pdf",
      "deleted": false,
      "description": "Specification document for compressor performance and operating constraints.",
      "id": "990e8400-e29b-41d4-a716-446655440000",
      "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.poelis.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Enter your API key. Example: Bearer poelis_api_...

Query Parameters

​
workspace_id
string | null

Workspace ID scope

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
product_id
string | null

Product ID scope

Example:

"660e8400-e29b-41d4-a716-446655440000"

​
item_id
string | null

Item ID scope

Example:

"770e8400-e29b-41d4-a716-446655440000"

​
property_id
string | null

Property ID scope

Example:

"880e8400-e29b-41d4-a716-446655440000"

​
version
string | null

Product version number (integer) or 'baseline'. Omit or null for draft.

Example:

null

​
include_property_files
boolean
default:false

When item_id is provided, include files linked to the item's properties.

​
q
string

Optional search query to filter results.

​
content_type
string | null

Filter by exact MIME type.

​
uploaded_by
string | null

Filter by uploader user ID.

​
has_links
boolean | null

Filter by linked/unlinked files.

​
include_deleted
boolean
default:false

Include soft-deleted files.

​
limit
integer
default:50

Maximum number of items to return per page. Must be between 1 and 200.

Required range: 1 <= x <= 200
​
offset
integer
default:0

Number of items to skip from the beginning of the result set. Used for pagination.

Required range: x >= 0

Response

Paginated list of files with metadata and current link usages.

Response payload for listing files.

​
items
PublicFile · object[]
required
​
count
integer
required