Skip to main content
GET
/
v1
/
objects
/
{object_id}
/
documents
Get all documents derived from an object
curl --request GET \
  --url https://api.mixpeek.com/v1/objects/{object_id}/documents
{}

Headers

Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

object_id
string
required

Root object ID to find all derived documents

Query Parameters

collection_ids
string[]

Optional: Filter to specific collections

Response

Successful Response

The response is of type Response Get Documents By Object V1 Objects Object Id Documents Get · object.