Skip to main content

Overview

Custom Objects allow administrators to define arbitrary data types tailored to their auction’s needs. Create objects like Dealerships, Fleets, Vendors, or any entity your operation requires, then populate them with records and relate them to other objects.

Object Types

Define custom schemas with typed fields

Record Management

Create, edit, search, and paginate records

CSV Import

Bulk import records from CSV files

Query Builder

Query custom object data with natural language

Permission Requirements

ActionOwnerAdminTeam Member
Create Object TypesYesYesNo
Edit Object TypesYesYesNo
Delete Object TypesYesYesNo
View RecordsYesYesNo
Create/Edit RecordsYesYesNo
Import CSVYesYesNo
Custom Objects are scoped to your auction. Each auction has its own set of object types and records, isolated by multi-tenant security policies.

Creating an Object Type

Define a new custom object with a schema of typed fields.
1

Navigate to Object Settings

Go to Settings in the sidebar, then click Objects
2

Click New Object

Click the New Object button in the Custom Objects section
3

Enter Basic Info

Provide the following details:
FieldDescriptionExample
NameMachine name (lowercase, underscores)dealerships
Display NameSingular display nameDealership
Plural Display NamePlural formDealerships
IconLucide icon namebuilding-2
DescriptionOptional descriptionDealership partners
4

Add Fields

Click Add Field to define each field in your schema:
SettingDescription
Field NameMachine name (lowercase, underscores)
Display NameHuman-readable label
Data Typetext, number, date, boolean, or select
RequiredWhether the field must have a value
OptionsFor select type: list of allowed values
5

Configure Field Metadata

Optionally set analytics metadata for each field:
MetadataPurpose
FilterableField appears as a filter option in the query builder
GroupableField can be used for GROUP BY operations
AggregatableField can be summed, averaged, etc.
6

Create Object

Click Create to save the object type

Field Data Types

TypeStorageExample Values
textString”Acme Motors”, “123 Main St”
numberNumeric42, 3.14, -10
dateDate string”2026-01-15”
booleanTrue/Falsetrue, false
selectConstrained string”active”, “inactive”, “pending”
Choose select for fields with a known set of values (e.g., status, region, tier). This enables dropdown selection in forms and better filtering in analytics.

Naming Guidelines

GuidelineGoodBad
Use lowercase with underscoresdealershipsDealerships, dealer-ships
Be descriptive but conciseprimary_contactpc, the_primary_contact_person
Avoid reserved wordsfleet_namename, type, id

Managing Records

After creating an object type, you can add and manage individual records.

Accessing the Record Browser

1

Navigate to Objects

Click Objects in the sidebar under the Data Management section
2

Select Object Type

Click on the object type you want to manage (e.g., “Dealerships”)
3

View Records

See all records in a paginated, searchable table

Creating a Record

1

Click New Record

Click the New Record button above the records table
2

Fill in Fields

Enter values for each field defined in the object schema. Required fields are marked with an asterisk.
3

Save Record

Click Save to create the record

Editing a Record

1

Find the Record

Use search or pagination to locate the record
2

Click the Row

Click the record row to open the edit dialog
3

Update Fields

Modify field values as needed
4

Save Changes

Click Save to apply updates

Deleting a Record

1

Find the Record

Locate the record in the table
2

Click Row Actions

Click the actions menu on the record row
3

Confirm Deletion

Review the confirmation dialog and click Delete
Deleting a record is permanent. If the record is linked to other objects via associations, those links are also removed.

Searching and Sorting

FeatureDescription
SearchFilter records by text fields (searches across all text-type fields)
SortClick any column header to sort ascending/descending
PaginationNavigate through large record sets with page controls

CSV Import

Bulk import records into a custom object from a CSV file.
1

Open Import Dialog

From the record browser, click Import CSV
2

Upload CSV File

Drag and drop or browse to select your CSV file
3

Map Columns

Map CSV columns to object fields. The system auto-matches columns with similar names.
4

Choose Import Mode

Select how to handle existing data:
ModeBehavior
AppendAdd new records without affecting existing ones
Replace AllDelete all existing records and import fresh
5

Review and Import

Review the mapping summary and click Import to begin
The CSV import processes in the background. You can navigate away and return to check the status. Import history is available in the Analytics Import tab.

CSV Format Requirements

RequirementDetails
Header rowFirst row must contain column names
EncodingUTF-8 recommended
DelimiterComma (,)
Max file size50 MB

Editing an Object Type

Modify an existing object type’s display name, icon, description, or field schema.
1

Navigate to Object Settings

Go to SettingsObjects
2

Click Edit

Click the edit icon on the object type card
3

Update Fields

Modify the object type details or add/remove fields from the schema
4

Save Changes

Click Save to apply updates
Removing a field from the schema does not delete existing data for that field in records. However, the field will no longer appear in forms or the record browser.

Deleting an Object Type

Remove an object type and all of its records.
1

Navigate to Object Settings

Go to SettingsObjects
2

Click Delete

Click the delete icon on the object type card
3

Review Impact

The dialog shows how many records will be deleted and which associations will be removed
4

Confirm Deletion

Type the object name to confirm and click Delete
Deleting an object type permanently removes all of its records and any association links involving this object. This action cannot be undone.

Using Custom Objects in Analytics

Custom objects are available as data sources in the Query Builder. Ask natural language questions about your custom data just like any other data source.

Example Queries

ObjectExample Query
Dealerships”Show me total records by region”
Fleets”How many active fleets were added this month?”
Vendors”List vendors with contract_value over 50000”
For best results, configure field metadata (filterable, groupable, aggregatable) when creating your object type. This helps the AI generate more accurate queries.

Best Practices

Before creating an object type, map out:
  • What fields do you need?
  • Which fields should be required?
  • What data types are appropriate?
  • Will you need to filter or group by any fields in analytics?
When a field has a finite set of values (status, region, tier), use the select type. This:
  • Prevents typos and inconsistent data
  • Enables dropdown selection in forms
  • Improves analytics filtering accuracy
Begin with a minimal set of fields and add more as your needs become clearer. You can always add fields to an existing object type without affecting existing records.
Instead of duplicating data across objects, use the Data Model to create associations between objects. This enables cross-object queries in the Query Builder.