Schemas (v1)

List schemas

Get the schemas matching the specified parameters.

get/schemas

Request

  • Base URL
    https://psrc-00000.region.provider.confluent.cloud
  • URL
    https://psrc-00000.region.provider.confluent.cloud/schemas
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Query parameters

subjectPrefixstring

Filters results by the respective subject prefix

aliasesboolean

Whether to include aliases in the search

deletedboolean

Whether to return soft deleted schemas

latestOnlyboolean

Whether to return latest schema versions only for each matching subject

ruleTypestring

Filters results by the given rule type

offsetinteger

Pagination offset for results

limitinteger

Pagination size for results. Ignored if negative

Response

List of schemas matching the specified parameters.

subjectstring

Name of the subject

versioninteger

Version number

idinteger

Globally unique identifier of the schema

schemaTypestring

Schema type

schemastring

Schema definition string

Example response

[
  {
    "subject": "User",
    "version": 1,
    "id": 100001,
    "schemaType": "AVRO",
    "references": [
      {
        "name": "io.confluent.kafka.example.User",
        "subject": "User",
        "version": 1
      }
    ],
    "schema": "{\"schema\": \"{\"type\": \"string\"}\"}"
  }
]

Changes

No recorded changes to this operation across all 7 revisions of this API.