Skip to main content
POST /v1/tenants/{tenant_id}/schemas/list Returns a paginated list of schema versions for the tenant, ordered from newest to oldest. Each entry includes the version identifier and the timestamp at which it was created. The response also includes the head field indicating the latest schema version.

​
Path Parameters

​
tenant_id
string
required
The tenant identifier. Use t1 for single-tenant deployments. Must match ^([a-zA-Z0-9_\-@\.:+]{1,128}|\*)$.

​
Request Body

​
page_size
integer
Number of schema versions to return per page. Must be >= 1.
​
continuous_token
string
Pagination token from a previous response. Omit for the first page.

​
Response

​
head
string
The version identifier of the latest (head) schema for this tenant.
​
schemas
array
Ordered list of schema versions.
​
continuous_token
string
Pagination token for retrieving the next page. Empty when there are no more results.

​
Example

curl --location --request POST 'localhost:3476/v1/tenants/{tenant_id}/schemas/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page_size": 20,
    "continuous_token": ""
}'
Request body 
{
  "page_size": 20,
  "continuous_token": ""
}
Response 
{
  "head": "cnbe6se5fmal18gpc66g",
  "schemas": [
    {
      "version": "cnbe6se5fmal18gpc66g",
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "version": "anbz3re2amal09fpc44f",
      "created_at": "2024-01-10T08:00:00Z"
    }
  ],
  "continuous_token": ""
}

​
Error Codes

HTTP StatusDescription
400Bad request — invalid fields
401Unauthorized
404Tenant not found
429Rate limit exceeded
500Internal server error

Build docs developers (and LLMs) love

Get started for freeTalk to us