Sign in

Get entity schema

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

Returns one entity's JSON Schema: its properties, its required fields, and its row-level security rules under rls. Use List entity schemas to see which entity names the app has.

For the app's own entities the schema also carries a name key holding the entity name, which Base44 sets on every write. The User schema does not have one.

Pass User as the entity_name to read the custom fields added to the built-in user entity. That returns only those custom fields, not the built-in ones, and returns a 404 when the app has not added any.

<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/{entity_name}

Path parameters

entity_namestring required

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

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

app_idstring required

ID of the app whose entity schemas you want.

ID of the app whose entity schemas you want.

Response

Successful Response

object required

The entity's JSON Schema, as stored.

Changes

Changed in 2 of the 11 revisions of this API.2