> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/api-reference/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>



## OpenAPI

````yaml /developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entity-schemas/{entity_name}
openapi: 3.1.0
info:
  title: Base44 App Management API
  version: 1.0.0
servers:
  - url: https://app.base44.com
security:
  - ApiKeyAuth: []
paths:
  /api/apps/{app_id}/entity-schemas/{entity_name}:
    get:
      summary: Get entity schema
      description: >-
        <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](/api-reference/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>
      operationId: get_schema_api_apps__app_id__entity_schemas__entity_name__get
      parameters:
        - name: entity_name
          in: path
          required: true
          schema:
            type: string
            description: >-
              Name of the entity, as returned by [List entity
              schemas](/api-reference/list-entity-schemas). Pass `User` for the
              built-in user entity.
            title: Entity Name
          description: >-
            Name of the entity, as returned by [List entity
            schemas](/api-reference/list-entity-schemas). Pass `User` for the
            built-in user entity.
          example: Invoice
        - name: app_id
          in: path
          required: true
          schema:
            type: string
            description: ID of the app whose entity schemas you want.
            title: App Id
          description: ID of the app whose entity schemas you want.
          example: 6820f3a4e7b91d003c45a1f2
      responses:
        '200':
          description: The entity's schema.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: EntitySchemaDocument
                description: The entity's JSON Schema, as stored.
              example:
                name: Invoice
                type: object
                properties:
                  amount:
                    type: number
                    description: Total amount in cents
                  status:
                    type: string
                    enum:
                      - draft
                      - sent
                      - paid
                required:
                  - amount
                rls:
                  read:
                    created_by: '{{user.email}}'
        '401':
          description: Missing or invalid credentials.
        '403':
          description: >-
            You don't have editor access to this app, or you used a workspace
            API key.
        '404':
          description: >-
            App not found, the app has no entity with this name, or `User` was
            requested and the app has no custom user fields.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key
      description: Personal API key.

````