Skip to main content
POST
/
api
/
v1
/
airbyte
/
objects
/
list
/
List Objects
curl --request POST \
  --url https://app.superleap.com/api/v1/airbyte/objects/list/ \
  --header 'Authorization: <authorization>'
Retrieve a list of all available entities in your organization. This endpoint is used by the Airbyte connector to discover which Superleap objects can be used as data sources.

​
Headers

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

​
Example Request

curl --location --request POST 'https://app.superleap.com/api/v1/airbyte/objects/list/' \
--header 'Authorization: Bearer SUPERSECRETREDACTEDKEY' \
--data ''

​
Example Response

{
    "success": true,
    "data": [
        {
            "entity_identifier": "lead",
            "label": "Lead",
            "description": "",
            "has_nested_entities": false,
            "is_writable": false
        },
        {
            "entity_identifier": "opportunity",
            "label": "Opportunity",
            "description": "",
            "has_nested_entities": false,
            "is_writable": false
        },
        {
            "entity_identifier": "companies",
            "label": "Company",
            "description": "",
            "has_nested_entities": false,
            "is_writable": false
        },
        {
            "entity_identifier": "user",
            "label": "User",
            "description": "",
            "has_nested_entities": false,
            "is_writable": false
        },
        {
            "entity_identifier": "call_log",
            "label": "Calllog",
            "description": "",
            "has_nested_entities": false,
            "is_writable": false
        }
    ]
}

​
Response Fields

FieldTypeDescription
successbooleanWhether the request was successful
dataarrayList of entity objects

​
Entity Object

FieldTypeDescription
entity_identifierstringUnique slug identifier for the entity (used as object_slug in other endpoints)
labelstringHuman-readable display name of the entity
descriptionstringDescription of the entity
has_nested_entitiesbooleanWhether this entity contains nested sub-entities
is_writablebooleanWhether Airbyte can write data to this entity