Skip to main content
GET
Get entity schema

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

entity_name
string
required

Name of the entity, as returned by List entity schemas. Pass User for the built-in user entity.

app_id
string
required

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

Response

Successful Response

The entity's stored JSON Schema, including its properties, required fields, and any row-level security rules under rls. For the app's own entities it also carries a name key holding the entity name. For User it holds only the custom fields added on top of the built-in ones, and has no name key.