Skip to main content
Please test your implementation on the sandbox/staging environment before releasing to PRODUCTION

​
Welcome

Superleap provides several APIs to work with object data in your organization. These APIs allow you to list available objects, retrieve object schemas, and filter object records based on various criteria.

Get List of Objects

Discover all available objects in your organization

Get Object Schema

Retrieve detailed schema information for a specific object

Filter Object Data

Query and filter records for any object

Create Bulk Records

Create Bulk Records

Get A Record

Get A Record

Update Record

Update Record

Bulk Upsert Records

Bulk Upsert Records

​
Authentication

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

​
Implementation Flow

A typical workflow for fetching object data involves:
  1. List Objects - First, retrieve a list of all available objects in your organization to understand what data you can access
  2. Get Object Schema - For objects of interest, fetch their schema to understand the available fields and relationships
  3. Filter Data - Use the filter endpoint to query specific records based on your criteria

​
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