Skip to main content

Get All Schemas

Endpoint: GET /api/schema

Retrieves all schemas from your Conductor cluster.

Query parameters

ParameterDescriptionTypeRequired/ Optional
shortWhether to return the short version of the schema definition, which has only name, version, createTime, and updateTime fields. Default is false.booleanOptional.

Response

Returns an array of schema objects. Each object contains the retrieved schema definition. When short=true, only the name, version, createTime, and updateTime fields are returned.

Examples

Get all schemas

Request

curl -X 'GET' \
'https://<YOUR-SERVER-URLS>/api/schema?short=false' \
-H 'accept: application/json' \
-H 'X-Authorization: <TOKEN>'

Response

[
{
"createTime": 1770719679827,
"updateTime": 1770719679827,
"createdBy": "john.doe@acme.com",
"updatedBy": "john.doe@acme.com",
"name": "itemSchema",
"version": 1,
"type": "JSON",
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://example.com/product.schema.json",
"type": "object",
"properties": {
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the car",
"type": "string"
}
},
"required": [
"productId"
]
}
},
{
"createTime": 1770719857291,
"updateTime": 1770719857291,
"createdBy": "john.doe@acme.com",
"updatedBy": "john.doe@acme.com",
"name": "itemSchema",
"version": 2,
"type": "JSON",
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://example.com/product.schema.json",
"type": "object",
"properties": {
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the product",
"type": "string"
},
"productType": {
"description": "Type of the product",
"type": "string"
}
},
"required": [
"productId"
]
}
},
{
"createTime": 1767678326224,
"updateTime": 1767678326224,
"createdBy": "john.doe@acme.com",
"updatedBy": "john.doe@acme.com",
"name": "FeedbackSchema",
"version": 1,
"type": "JSON",
"data": {
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"properties": {
"rating": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"comment": {
"type": "string"
}
},
"required": [
"rating",
"comment"
]
}
},
{
"createTime": 1763622167039,
"updateTime": 1763622167039,
"createdBy": "john.doe@acme.com",
"updatedBy": "john.doe@acme.com",
"name": "productSchema",
"version": 1,
"type": "JSON",
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productId": {
"type": "integer"
}
},
"required": [
"productId"
]
}
},
{
"createTime": 1769066240839,
"updateTime": 1769066240839,
"createdBy": "john.doe@acme.com",
"updatedBy": "john.doe@acme.com",
"name": "customerSchema",
"version": 1,
"type": "JSON",
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string"
}
},
"required": [
"customerId"
]
}
}
]
Get all schemas with short set to true

Request

curl -X 'GET' \
'https://<YOUR-SERVER-URL>/api/schema?short=true' \
-H 'accept: application/json' \
-H 'X-Authorization: <TOKEN>'

Response

[
{
"createTime": 0,
"updateTime": 0,
"name": "itemSchema",
"version": 1
},
{
"createTime": 0,
"updateTime": 0,
"name": "itemSchema",
"version": 2
},
{
"createTime": 0,
"updateTime": 0,
"name": "FeedbackSchema",
"version": 1
},
{
"createTime": 0,
"updateTime": 0,
"name": "productSchema",
"version": 1
},
{
"createTime": 0,
"updateTime": 0,
"name": "customerSchema",
"version": 1
}
]