Skip to main content
GET
/
api
/
v1
/
appflow
/
objects
/
{object_slug}
Get Object
curl --request GET \
  --url https://app.superleap.com/api/v1/appflow/objects/{object_slug} \
  --header 'Authorization: <authorization>'

Documentation Index

Fetch the complete documentation index at: https://docs.superleap.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve the schema and field definitions for a specific entity. This endpoint is used by the AppFlow connector to discover available fields when configuring a flow.

​
Headers

​
Authorization
string
required
Bearer token for authentication, click here to generate one

​
Path Parameters

​
object_slug
string
required
The entity identifier for the object (e.g., “lead”, “user”, “opportunity”). Use the List Objects endpoint to discover available identifiers.

​
Example Request

curl --location 'https://app.superleap.com/api/v1/appflow/objects/lead' \
--header 'Authorization: Bearer SUPERSECRETREDACTEDKEY'

​
Example Response

{
    "success": true,
    "data": {
        "entity_identifier": "lead",
        "label": "Lead",
        "description": "",
        "has_nested_entities": false,
        "is_writable": false,
        "fields": [
            {
                "field_name": "id",
                "data_type": "String",
                "data_type_label": "varchar",
                "label": "Record id",
                "description": "",
                "is_primary_key": true,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": false,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": false
                }
            },
            {
                "field_name": "name",
                "data_type": "String",
                "data_type_label": "varchar",
                "label": "Name",
                "description": "",
                "is_primary_key": false,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": true,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": false
                }
            },
            {
                "field_name": "email",
                "data_type": "String",
                "data_type_label": "email",
                "label": "Email",
                "description": "",
                "is_primary_key": false,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": true,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": false
                }
            },
            {
                "field_name": "phone",
                "data_type": "String",
                "data_type_label": "phone",
                "label": "Phone",
                "description": "",
                "is_primary_key": false,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": true,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": false
                }
            },
            {
                "field_name": "created_at",
                "data_type": "DateTime",
                "data_type_label": "timestamp",
                "label": "Created at",
                "description": "",
                "is_primary_key": false,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": true,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": true
                }
            },
            {
                "field_name": "updated_at",
                "data_type": "DateTime",
                "data_type_label": "timestamp",
                "label": "Updated at",
                "description": "",
                "is_primary_key": false,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": true,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": true
                }
            },
            {
                "field_name": "owner",
                "data_type": "String",
                "data_type_label": "relation",
                "label": "Owner",
                "description": "",
                "is_primary_key": false,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": true,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": false
                }
            },
            {
                "field_name": "external_id",
                "data_type": "String",
                "data_type_label": "varchar",
                "label": "External id",
                "description": "",
                "is_primary_key": false,
                "is_deprecated": false,
                "read_properties": {
                    "is_retrievable": true,
                    "is_nullable": true,
                    "is_queryable": false,
                    "is_timestamp_field_for_incremental_queries": false
                }
            }
        ]
    }
}

​
Response Fields

FieldTypeDescription
successbooleanWhether the request was successful
dataobjectThe entity schema details

​
Entity Schema

FieldTypeDescription
entity_identifierstringUnique slug identifier for the entity
labelstringHuman-readable display name
descriptionstringDescription of the entity
has_nested_entitiesbooleanWhether this entity contains nested sub-entities
is_writablebooleanWhether AppFlow can write data to this entity
fieldsarrayList of field definitions for the entity

​
Field Object

FieldTypeDescription
field_namestringThe field’s programmatic name (used in queries and responses)
data_typestringThe field’s data type (String, Boolean, DateTime, Integer, Float)
data_type_labelstringSpecific type label (e.g., varchar, email, phone, timestamp, enum, relation, bool)
labelstringHuman-readable display name for the field
descriptionstringDescription of the field
is_primary_keybooleanWhether this field is the primary key
is_deprecatedbooleanWhether this field is deprecated
read_propertiesobjectRead access properties for the field

​
Read Properties

FieldTypeDescription
is_retrievablebooleanWhether the field can be retrieved in queries
is_nullablebooleanWhether the field can contain null values
is_queryablebooleanWhether the field can be used in query filters
is_timestamp_field_for_incremental_queriesbooleanWhether this field can be used as a timestamp for incremental data syncs