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.

To read one schema on its own, use Get entity schema.

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

Path parameters

app_idstring required

ID of the app whose entity schemas you want to work with.

Response

Successful Response

totalinteger required

Number of entity schemas returned.

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"
      }
    },
    {
      "entity_name": "User",
      "entity_schema": {
        "properties": {
          "department": {
            "type": "string"
          },
          "employee_id": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  ],
  "total": 2
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.