Skip to main content
GET
/
api
/
v1
/
contents
List Contents
curl --request GET \
  --url https://api.example.com/api/v1/contents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "metadata": {},
      "type": "<string>",
      "size": 123,
      "status": "<string>",
      "sync_status": "<string>",
      "status_message": "<string>",
      "content_hash": "<string>",
      "file_data": {},
      "definition": "<string>",
      "created_at": 123,
      "updated_at": 123,
      "external_id": "<string>",
      "collection_id": "<string>",
      "workspace_id": "<string>",
      "config": {},
      "linked_to": "<string>",
      "access_count": 123
    }
  ],
  "total_count": 123,
  "page": 123,
  "limit": 123,
  "next_page": 123,
  "next_cursor": "<string>",
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Workspace-Id
string | null

The workspace ID

Query Parameters

​
collection_id
string | null

Filter by collection ID

​
status
string | null

Filter by status (new, processing, completed, failed)

​
skip
integer
default:0

Number of contents to skip

Required range: x >= 0
​
limit
integer
default:100

Number of contents to return

Required range: 1 <= x <= 1000
​
sort_by
string
default:created_at

Field to sort by

​
sort_order
string
default:desc

Sort order (asc/desc)

Response

Successful Response

​
data
ContentRead · object[]
required
​
total_count
integer
required
​
page
integer | null
​
limit
integer | null
​
next_page
integer | null
​
next_cursor
string | null
​
has_more
boolean | null