Skip to main content
GET
/
api
/
collections
/
{collection_id}
Get Collection
curl --request GET \
  --url https://api.example.com/api/collections/{collection_id}
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "openapi_spec": {},
  "created_by": "<string>",
  "created_at": "<string>"
}

Authentication

Supports both Firebase and API Key authentication:
Authorization
string
Bearer token: Bearer <firebase_id_token>
OR
X-Client-ID
string
Client identifier
X-API-Key
string
Client secret

Path Parameters

collection_id
string
required
Collection ID (UUID)

Example Request

curl https://api.sari-platform.com/api/collections/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer <token>"

Response

id
string
Collection ID
name
string
Collection name
description
string
Collection description
openapi_spec
object
Full OpenAPI 3.0 specification
created_by
string
Creator’s profile ID
created_at
string
Creation timestamp

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Stripe Payment API",
  "description": "Payment processing API",
  "openapi_spec": {
    "openapi": "3.0.0",
    "info": {
      "title": "Stripe Payment API",
      "version": "1.0.0"
    },
    "servers": [
      {"url": "https://api.stripe.com"}
    ],
    "paths": { ... }
  },
  "created_by": "admin-uuid",
  "created_at": "2024-01-10T08:00:00Z"
}

Errors

StatusDescription
401Invalid authentication
403No access to this collection
404Collection not found