Get Object

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

import requests

url = "https://app.superleap.com/api/v1/appflow/objects/{object_slug}"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://app.superleap.com/api/v1/appflow/objects/{object_slug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.superleap.com/api/v1/appflow/objects/{object_slug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.superleap.com/api/v1/appflow/objects/{object_slug}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.superleap.com/api/v1/appflow/objects/{object_slug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

GET

api

appflow

objects

{object_slug}

Get Object

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

import requests

url = "https://app.superleap.com/api/v1/appflow/objects/{object_slug}"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://app.superleap.com/api/v1/appflow/objects/{object_slug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.superleap.com/api/v1/appflow/objects/{object_slug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.superleap.com/api/v1/appflow/objects/{object_slug}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.superleap.com/api/v1/appflow/objects/{object_slug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

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

string

required

Bearer token for authentication, click here to generate one

Path Parameters

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

Field	Type	Description
`success`	boolean	Whether the request was successful
`data`	object	The entity schema details

Entity Schema

Field	Type	Description
`entity_identifier`	string	Unique slug identifier for the entity
`label`	string	Human-readable display name
`description`	string	Description of the entity
`has_nested_entities`	boolean	Whether this entity contains nested sub-entities
`is_writable`	boolean	Whether AppFlow can write data to this entity
`fields`	array	List of field definitions for the entity

Field Object

Field	Type	Description
`field_name`	string	The field’s programmatic name (used in queries and responses)
`data_type`	string	The field’s data type (`String`, `Boolean`, `DateTime`, `Integer`, `Float`)
`data_type_label`	string	Specific type label (e.g., `varchar`, `email`, `phone`, `timestamp`, `enum`, `relation`, `bool`)
`label`	string	Human-readable display name for the field
`description`	string	Description of the field
`is_primary_key`	boolean	Whether this field is the primary key
`is_deprecated`	boolean	Whether this field is deprecated
`read_properties`	object	Read access properties for the field

Read Properties

Field	Type	Description
`is_retrievable`	boolean	Whether the field can be retrieved in queries
`is_nullable`	boolean	Whether the field can contain null values
`is_queryable`	boolean	Whether the field can be used in query filters
`is_timestamp_field_for_incremental_queries`	boolean	Whether this field can be used as a timestamp for incremental data syncs

Fetch Object Data APIs

Record Management APIs

Analytics Query APIs

Appflow APIs

Airbyte APIs

Get Object

Headers

Path Parameters

Example Request

Example Response

Response Fields

Entity Schema

Field Object

Read Properties

​Headers

​Path Parameters

​Example Request

​Example Response

​Response Fields

​Entity Schema

​Field Object

​Read Properties

Headers

Path Parameters

Example Request

Example Response

Response Fields

Entity Schema

Field Object

Read Properties