Skip to main content
GET
/
api
/
v2
/
_schema
/
{record_type}
Introspect a record type's public schema
curl --request GET \
  --url https://api.example.com/api/v2/_schema/{record_type} \
  --header 'Authorization: Bearer <token>'
{
  "api_name": "<string>",
  "display_name": "<string>",
  "is_custom": true,
  "is_junction": true,
  "supports_custom_fields": true,
  "attributes": [
    {
      "api_name": "<string>",
      "display_name": "<string>",
      "is_creatable": true,
      "is_updatable": true,
      "type_info": {
        "is_array": true,
        "value_type": "string"
      },
      "description": "<string>",
      "is_required_on_create": false,
      "is_unique": false,
      "is_custom": false,
      "is_sortable": false,
      "is_filterable": false,
      "filter_operators": [
        "<string>"
      ]
    }
  ],
  "relationships": [
    {
      "api_name": "<string>",
      "display_name": "<string>",
      "related_object_api_name": "<string>",
      "is_creatable": true,
      "is_updatable": true,
      "description": "<string>",
      "related_object_relationship_api_name": "<string>",
      "junction_object_api_name": "<string>",
      "is_custom": false,
      "is_array": true
    }
  ],
  "description": "<string>"
}

Authorizations

Authorization
string
header
required

Reevo API key passed as Authorization: Bearer <api-key>.

Path Parameters

record_type
string
required

Response

Successful Response

Top-level public schema descriptor for one record_type.

record_type is the public name (after the cross-record-type rename, e.g. internal pipeline -> public opportunity). object_id is set only for custom objects -- standard record_types leave it None.

Spec §3.6 (PublicSchema).

api_name
string
required
display_name
string
required
is_custom
boolean
required
is_junction
boolean
required
supports_custom_fields
boolean
required
attributes
FieldSchema · object[]
required
relationships
RelationshipSchema · object[]
required
description
string | null