List Schema

POST /v1/tenants/{tenant_id}/schemas/list

go

Go

sr, err := client.Schema.List(context.Background(), &v1.SchemaListRequest{
    TenantId: "t1",
    PageSize: 20,
    ContinuousToken: "",
})

200

{
  "head": "<string>",
  "schemas": [
    {
      "version": "<string>",
      "created_at": "<string>"
    }
  ],
  "continuous_token": "<string>"
}

Models written to Permify using the write schema API can be listed using this API with the timestamps at which the models were created.

Request needs to be made to the API endpoint /v1/tenants//schemas/list to list all the models.

Example Request on Postman

POST /v1/tenants/{tenant_id}/schemas/list

Path Parameters

tenant_id · string · required

Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant t1 for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.

Body

application/json

SchemaListRequest is the request message for the List method in the Schema service. It contains tenant_id for which the schemas are to be listed.

page_size · integer<int64>

page_size is the number of schemas to be returned in the response. The value should be between 1 and 100.

continuous_token · string

continuous_token is an optional parameter used for pagination. It should be the value received in the previous response.

Response

200

application/json

A successful response.

head · string

schemas · SchemaList provides a list of schema versions with their corresponding creation timestamps · object[]

Show child attributes

continuous_token · string

continuous_token is a string that can be used to paginate and retrieve the next set of results.