Skip to main content
GET
/
api
/
v1
/
collections
/
{collection_id}
Get Collection
curl --request GET \
  --url https://api.example.com/api/v1/collections/{collection_id}
{
  "id": "<string>",
  "name": "<string>",
  "table_name": "<string>",
  "schema": [
    {
      "name": "<string>",
      "type": "<string>",
      "required": false,
      "default": "<unknown>",
      "unique": false,
      "options": {},
      "collection": "<string>",
      "on_delete": "<string>",
      "pii": false,
      "mask_type": "<string>",
      "expression": "<string>",
      "return_type": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
collection_id
string
required

Response

Successful Response

Response for a created collection.

​
id
string
required

Collection ID (UUID)

​
name
string
required

Collection name

​
table_name
string
required

Physical table name in database

​
schema
SchemaFieldResponse · object[]
required

Collection schema

​
created_at
string<date-time>
required

When the collection was created

​
updated_at
string<date-time>
required

When the collection was last updated