Sign in

List entity schemas

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns every entity schema the app defines, plus the built-in User entity when it has custom fields.

Each entry pairs the entity name with its JSON Schema: the entity's properties, its required fields, and its row-level security rules under rls. To read one schema on its own, use Get entity schema.

<Note>This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.</Note>

get/api/apps/{app_id}/entity-schemas

Path parameters

app_idstring required

ID of the app whose entity schemas you want.

ID of the app whose entity schemas you want.

Response

The app's entity schemas.

totalinteger required

Number of schemas in schemas.

Example response

{
  "schemas": [
    {
      "entity_name": "Invoice",
      "entity_schema": {
        "name": "Invoice",
        "properties": {
          "amount": {
            "description": "Total amount in cents",
            "type": "number"
          },
          "status": {
            "enum": [
              "draft",
              "sent",
              "paid"
            ],
            "type": "string"
          }
        },
        "required": [
          "amount"
        ],
        "rls": {
          "read": {
            "created_by": "{{user.email}}"
          }
        },
        "type": "object"
      }
    }
  ],
  "total": 3
}

Changes