GET
/
v1
/
collections
/
{collection_identifier}
/
documents
curl --request GET \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents
{
  "items": [
    {
      "document_id": "<string>",
      "collection_id": "<string>",
      "internal_id": "<string>",
      "namespace_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "vectors": {}
    }
  ],
  "total": 123,
  "next_offset_id": "<string>"
}

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Path Parameters

​
collection_identifier
string
required

The ID of the collection

Query Parameters

​
limit
integer
default:10

Number of documents to return per page

Required range: 1 <= x <= 100
​
offset_id
string | null

ID of the document to start pagination from

​
sort
string | null

Field to sort by

​
filters
string | null

Filter criteria

​
select
string | null

Fields to select

Response

200
application/json
Successful Response

Model for paginated document list response

​
items
object[]
required

Model for document response

​
total
integer
required
​
next_offset_id
string | null

Was this page helpful?

Suggest editsRaise issue