Schema

Retrieve all schemas

get

Returns a list of all available schemas in the current workspace. Each schema defines the structure of a data collection, including its fields, validation rules, and display configurations. Use this endpoint to discover available data structures before querying or inserting data.

Responses

200

List of schemas retrieved successfully

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

get

/api/schema/

HTTPcURLJavaScriptPython

GET /api/schema/ HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Customers",
    "slug": "customers",
    "auditable": true,
    "commentable": true,
    "fields": [
      {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "fieldType": "TextField",
        "headerName": "Name",
        "slug": "name",
        "required": true,
        "unique": false
      },
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "fieldType": "TextField",
        "headerName": "Email",
        "slug": "email",
        "required": true,
        "unique": true
      }
    ],
    "viewsConfig": []
  }
]

Retrieve a schema by ID

get

Fetches a specific schema by its unique identifier. Returns the complete schema definition including all fields with their types, validation rules, and additional properties. Use this endpoint to get detailed information about a specific data structure before performing operations on its records.

Path parameters

schemaIdstring · uuidRequired

Unique identifier (UUID) of the schema to retrieve

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Schema retrieved successfully

application/json

400

Invalid schema ID format - The provided ID is not a valid UUID

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Schema not found - No schema exists with the provided ID

application/json

get

/api/schema/{schemaId}

HTTPcURLJavaScriptPython

GET /api/schema/{schemaId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Products",
  "slug": "products",
  "auditable": true,
  "commentable": false,
  "fields": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "fieldType": "TextField",
      "headerName": "Product Name",
      "slug": "product-name",
      "required": true,
      "unique": false
    },
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fieldType": "NumberField",
      "headerName": "Price",
      "slug": "price",
      "required": true,
      "unique": false
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "fieldType": "OptionField",
      "headerName": "Category",
      "slug": "category",
      "required": false,
      "unique": false
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "fieldType": "ReferenceField",
      "headerName": "Supplier",
      "slug": "supplier",
      "required": false,
      "unique": false
    }
  ],
  "viewsConfig": [
    {
      "id": "default-view",
      "name": "Default View",
      "type": "grid",
      "default": true,
      "erasable": false
    }
  ]
}