ITitem
Schema

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.

get/api/meta/schema

Request

  • Base URL
    https://app.useitem.io
  • Auth
    API key in header x-api-key

Response

Schema returned

Example response

{
  "data": [
    {
      "id": 1,
      "slug": "contacts",
      "display_name": "People",
      "plural_display_name": "People",
      "fields": [
        {
          "field_name": "industry",
          "display_name": "Industry",
          "field_type": "select",
          "field_order": 5,
          "select_options": [
            {
              "label": "Technology",
              "value": "technology",
              "color": "#3b82f6"
            }
          ],
          "visibility_type": "visible"
        }
      ]
    }
  ]
}

Changes

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