Skip to main content
GET
/
v1
/
public
/
retrievers
List Public Retrievers
curl --request GET \
  --url https://api.mixpeek.com/v1/public/retrievers/ \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "public_name": "<string>",
      "public_url": "<string>",
      "title": "<string>",
      "password_protected": true,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "logo_url": "<string>",
      "og_image_url": "<string>"
    }
  ],
  "total_count": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "stats": {
    "total_active": 0,
    "total_password_protected": 0,
    "total_open": 0
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
page_size
integer
default:20

Results per page (max 100)

Required range: 1 <= x <= 100
include_inactive
boolean
default:false

Include inactive retrievers in results

search
string | null

Search query for filtering by title or description

Response

Successful Response

Response for listing public retrievers.

Follows the same pattern as ListCollectionsResponse for consistent developer experience.

results
PublicRetrieverListItem · object[]
required

List of public retrievers

total_count
integer
required

Total number of public retrievers matching the query

page
integer
required

Current page number

page_size
integer
required

Results per page

total_pages
integer
required

Total number of pages

stats
PublicRetrieverListStats · object

Aggregate statistics across all public retrievers