Skip to main content

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.

These APIs are used internally by the Superleap Airbyte connector Lambda function. They are documented here for anyone who wants to write their own custom flows using these APIs instead of the default connector.

​
Overview

The Superleap Airbyte APIs power the custom Airbyte connector. These endpoints allow the connector to verify credentials, discover available objects, retrieve object schemas, and fetch records from your Superleap organization.

Verify Connection

Validate API credentials and connectivity

List Objects

Discover all available entities in your organization

Get Object

Retrieve the schema and field definitions for an entity

Get Records

Fetch records for an entity with filtering and pagination

​
Authentication

All Airbyte API endpoints are authenticated using Bearer tokens. You can generate an API key from the API Access page in your Superleap dashboard.

​
Implementation Flow

The Airbyte connector uses these APIs in the following sequence:
  1. Verify — Validate the API key and connection to Superleap
  2. List Objects — Retrieve all available entities the connector can access
  3. Get Object — Fetch the schema for a selected entity to discover available fields
  4. Get Records — Pull records from the entity, optionally filtered by timestamp for incremental syncs

​
Request and Response Formats

All APIs follow a consistent format:
  • Requests use JSON for the request body
  • Responses include a success boolean and a data object containing the requested information
  • Error responses include error details in the error field