Skip to main contentObjects
Objects are the primary data structures in Superleap CRM. Examples include leads, users, opportunities, and call logs. Each object has a unique slug (identifier) and a schema defining its fields.
Slug
A unique identifier for objects, fields, or elements in the system. For example, “lead” is the slug for the Lead object.
Fields
Also called columns, these are the individual data points that make up an object. Fields have properties like data type, visibility, and unique constraints.
Audit Data
The record of changes made to objects over time. Useful for tracking the history of modifications to your CRM data.
Pointer
A reference used in audit data polling that indicates the last processed record. Consists of a random_id and updated_at timestamp.
Object Types
Lead
A potential customer or prospect that hasn’t been qualified or converted yet.
User
A person who has access to the Superleap CRM system, typically team members or employees.
Opportunity
A qualified lead that represents a potential sale or business opportunity.
Call Log
A record of phone interactions with customers or prospects.
Field Properties
column_data_type
Indicates the type of data a field can contain (e.g., string, number, date, enum).
column_type
Categorizes fields as “standard”, “system”, or “custom”.
is_primary
Indicates whether the field is the primary field for the object, typically used for display purposes.
is_indexed
Fields that are optimized for faster searching and filtering.
is_unique
Fields that must contain unique values across all records of that object type.
Relationships
relationship_type
Defines how objects are related to each other:
- Type 1: OneToOne - A one-to-one relationship between objects
- Type 2: OneToMany - A relationship where one object can be linked to many instances of another object
- Type 3: ManyToOne - A relationship where many objects can be linked to one instance of another object
- Type 4: ManyToMany - A relationship where many objects can be linked to many instances of another object
- Type 6: Restricted - A reference relationship typically used for object ownership and user references
relation
Contains information about how objects are related to each other, including the target object and field.
API Concepts
Filter Operators
Operators used to filter data in queries:
- eq: Equal to
- neq: Not equal to
- gt/lt: Greater than/Less than
- contains: String contains
- starts_with: String starts with
- is_empty/not_empty: Field is empty or not empty
Webhook Events
Real-time notifications sent when data changes, following the pattern object_slug.verb (e.g., “lead.create”).