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

# Get object schema

> Returns all object types available to the organization along with their
field definitions. Use this to discover what objects exist, what fields
they have, and what select options are available.

Includes both system object types (People, Companies) and any custom
object types created by the organization.




## OpenAPI

````yaml /openapi.yaml get /api/meta/schema
openapi: 3.1.0
info:
  title: item API
  description: >
    The item API provides full CRUD access to your organization's data — People,
    Companies, and Custom Objects.


    Use it to:

    - Push structured data into item on a schedule

    - Sync custom field values across your stack

    - Pull filtered records and pre-configured views

    - Use item as your source of truth for customer data


    ## Authentication


    All requests require an API key passed in the `x-api-key` header.


    You can generate an API key from **Settings > System > API Key** in your
    item workspace.


    ```bash

    curl -H "x-api-key: sk_live_..." https://app.useitem.io/api/objects/contacts

    ```
  version: 1.0.0
  contact:
    name: item Support
servers:
  - url: https://app.useitem.io
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - apiKey: []
tags:
  - name: Objects
    description: Create, read, update, and delete People, Companies, and Custom Objects.
  - name: Schema
    description: Discover available object types and their field definitions.
  - name: Users
    description: List organization members and their access levels.
  - name: Views
    description: List and execute pre-configured views to pull filtered data.
  - name: Batch
    description: Bulk create or update objects for high-frequency sync operations.
  - name: Webhooks
    description: Trigger skills (AI agents) via HTTP webhooks from external systems.
paths:
  /api/meta/schema:
    get:
      tags:
        - Schema
      summary: Get object schema
      description: |
        Returns all object types available to the organization along with their
        field definitions. Use this to discover what objects exist, what fields
        they have, and what select options are available.

        Includes both system object types (People, Companies) and any custom
        object types created by the organization.
      operationId: getSchema
      responses:
        '200':
          description: Schema returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ObjectTypeSchema'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ObjectTypeSchema:
      type: object
      properties:
        id:
          type: integer
          example: 1
        slug:
          type: string
          example: contacts
        display_name:
          type: string
          example: People
        plural_display_name:
          type: string
          nullable: true
          example: People
        description:
          type: string
          nullable: true
        icon:
          type: string
          nullable: true
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldDefinition'
    Error:
      type: object
      properties:
        error:
          type: string
          example: Object not found
    FieldDefinition:
      type: object
      properties:
        field_name:
          type: string
          example: industry
        display_name:
          type: string
          example: Industry
        field_type:
          type: string
          example: select
        field_order:
          type: integer
          example: 5
        is_required:
          type: boolean
          example: false
        description:
          type: string
          nullable: true
        select_options:
          description: Available options for select/multi-select fields
          nullable: true
          type: array
          items:
            type: object
            properties:
              label:
                type: string
                example: Technology
              value:
                type: string
                example: technology
              color:
                type: string
                nullable: true
                example: '#3b82f6'
        allow_multiple:
          type: boolean
          nullable: true
        related_object_type_id:
          type: integer
          nullable: true
          description: For relationship fields, the ID of the related object type
        relationship_type:
          type: string
          nullable: true
          enum:
            - one_to_one
            - one_to_many
            - many_to_one
            - many_to_many
            - null
        number_min:
          type: number
          nullable: true
        number_max:
          type: number
          nullable: true
        number_decimal_places:
          type: integer
          nullable: true
        currency_decimal_places:
          type: integer
          nullable: true
        default_value:
          type: string
          nullable: true
        visibility_type:
          type: string
          example: visible
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your organization's API key (starts with `sk_live_`)

````