Metadata

The metadata endpoint exposes a machine-readable list of public objects along with their fields, data types, and whether they are required. This is useful for building dynamic integrations.

List objects and fields

GET/v1/metadata/objects

Returns a list of all public objects (cases, clients, case_lists) with their field definitions.

Response Fields

Field	Type	Description
name	String	Object name
fields	Array	List of fields
fields[].name	String	Field name
fields[].type	String	Data type
fields[].required	Boolean	Required on create
fields[].description	String	Field description

TIP

The endpoint is cached and updates when new public fields are added, allowing integrations to refresh their local schema automatically.

Request

curl -X GET 'https://public-api.kayse.ai/v1/metadata/objects' \
-H 'X-API-KEY: your_api_key'

Response

[
  {
    "name": "cases",
    "fields": [
      {
        "name": "case_number",
        "type": "string",
        "required": false,
        "description": "Unique case identifier"
      },
      {
        "name": "status",
        "type": "string",
        "required": true,
        "description": "Case status"
      }
    ]
  },
  {
    "name": "clients",
    "fields": [
      {
        "name": "email",
        "type": "string",
        "required": false,
        "description": "Primary email"
      },
      {
        "name": "first_name",
        "type": "string",
        "required": true,
        "description": "First name"
      }
    ]
  },
  {
    "name": "case_lists",
    "fields": [
      {
        "name": "name",
        "type": "string",
        "required": true,
        "description": "List name"
      },
      {
        "name": "filter",
        "type": "object",
        "required": false,
        "description": "Saved case filter"
      }
    ]
  }
]