Skip to main content
GET
/
api
/
meta
/
schema
Get object schema
curl --request GET \
  --url https://app.useitem.io/api/meta/schema \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": 1,
      "slug": "contacts",
      "display_name": "People",
      "plural_display_name": "People",
      "description": "<string>",
      "icon": "<string>",
      "fields": [
        {
          "field_name": "industry",
          "display_name": "Industry",
          "field_type": "select",
          "field_order": 5,
          "is_required": false,
          "description": "<string>",
          "select_options": [
            {
              "label": "Technology",
              "value": "technology",
              "color": "#3b82f6"
            }
          ],
          "allow_multiple": true,
          "related_object_type_id": 123,
          "relationship_type": "one_to_one",
          "number_min": 123,
          "number_max": 123,
          "number_decimal_places": 123,
          "currency_decimal_places": 123,
          "default_value": "<string>",
          "visibility_type": "visible"
        }
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your organization's API key (starts with sk_live_)

Response

Schema returned

data
object[]