Manage standard and custom objects
frontline object [options] [command]List all objects
frontline object list [options]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a new object
frontline object create [options]Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Object definition (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get detailed info about an object (fields, views, record types)
frontline object get [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get the schema definition for an object
frontline object schema [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update an object (displayName, emoji, iconColor, description)
frontline object update [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Update payload (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Count rows in an object, with optional query filter
frontline object count [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--query <json> | Filter query (JSON) | |
--record-type <type> | Record type filter | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete an entire object (DESTRUCTIVE)
frontline object delete [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage fields (columns) on an object
frontline object field [options] [command]List all fields for an object (excludes internal system fields)
frontline object field list [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a new field on an object
frontline object field create [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Field definition (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update a field on an object
frontline object field update [options] <object> <field-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Updated field data (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete a field from an object
frontline object field delete [options] <object> <field-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get formula dependencies for a field
frontline object field dependencies [options] <object> <field-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage options on select-type fields
frontline object option [options] [command]List options for a select field
frontline object option list [options] <object> <field-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a new option on a select field
frontline object option create [options] <object> <field-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Option definition (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update an option
frontline object option update [options] <object> <option-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Updated option data (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete an option
frontline object option delete [options] <object> <option-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage record types on an object
frontline object record-type [options] [command]List record types for an object
frontline object record-type list [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a new record type
frontline object record-type create [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Record type definition (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update a record type
frontline object record-type update [options] <object> <record-type-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Updated record type data (JSON) | |
--default-view <id> | View ID to use as the record type's default view, or "none" to clear it | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete a record type
frontline object record-type delete [options] <object> <record-type-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage record-level security (RLS) per record type
frontline object record-type security [options] [command]Get record-level security (RLS) config for a record type
frontline object record-type security get [options] <object> <record-type-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update record-level security (RLS) for a record type
frontline object record-type security update [options] <object> <record-type-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Security config (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage views on an object
frontline object view [options] [command]List all views for an object
frontline object view list [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--record-type <id> | Only views belonging to this record type ID | |
--shared | Only shared/system views (excludes private views) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a new view on an object
frontline object view create [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | View definition (JSON) | |
--record-type <id> | Record type the view belongs to (the object's default record type if omitted) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update a view
frontline object view update [options] <object> <view-id>Options
| Flag | Description | Default |
|---|---|---|
--name <name> | New name for the view | |
--column-order <fields> | Comma-separated column names | |
--hidden-columns <fields> | Comma-separated column names | |
--dialog-field-order <fields> | Comma-separated column names | |
--sticky-columns <fields> | Comma-separated column names (TABLE views only) | |
--option-order <options> | Comma-separated option names or IDs (for Kanban columns) | |
--data <json> | Other updated view data (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete a view
frontline object view delete [options] <object> <view-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage relations between object records
frontline object relation [options] [command]Get records related through a named relation
frontline object relation get [options] <object> <id> <relation>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Reverse lookup: find records that point to a target through a relation
frontline object relation find-by [options] <object> <relation> <target-id>Options
| Flag | Description | Default |
|---|---|---|
--page <n> | Page number | 1 |
--page-size <n> | Rows per page | 50 |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Link a target record through a relation
frontline object relation link [options] <object> <id> <relation> <target-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Unlink a target record from a relation
frontline object relation unlink [options] <object> <id> <relation> <target-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage records (rows) in an object
frontline object record [options] [command]List records with optional filtering, search, and pagination
frontline object record list [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--search <term> | Full-text search | |
--page <n> | Page number | 1 |
--page-size <n> | Rows per page | 50 |
--limit <n> | Alias for --page-size | |
--query <json> | Filter query (JSON) | |
--sort <json> | Sort config (JSON) | |
| `--record-type <ids | all>` | Filter by numeric record type ID(s), comma-separated, or all |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get a single record by ID
frontline object record get [options] <object> <id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a new record
frontline object record create [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Record field values (JSON) | |
--record-type <id> | Numeric record type ID | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create multiple new records
frontline object record bulk-create [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Array of record field values (JSON) | |
--record-type <id> | Numeric record type ID applied to every row | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update a record
frontline object record update [options] <object> <id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Updated field values (JSON), inline | |
--file <path> | Updated field values JSON file; use - for stdin | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete a record
frontline object record delete [options] <object> <id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Change the record type of an object record
frontline object record change-record-type [options] <object> <id>Options
| Flag | Description | Default |
|---|---|---|
--target-record-type-id <id> | Target record type ID (number) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Export object data
frontline object export [options] [command]Export object as XLSX spreadsheet
frontline object export xlsx [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--query <json> | Filter query (JSON) | |
--search <term> | Full-text search filter | |
--sort <json> | Sort config (JSON) | |
--output <path> | Output file path | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Export object as CSV
frontline object export csv [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--query <json> | Filter query (JSON) | |
--search <term> | Full-text search filter | |
--sort <json> | Sort config (JSON) | |
--output <path> | Output file path | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage manually-logged activities on object rows (notes, calls, meetings, logged emails) — for synced inbox/chat history use 'object timeline'
frontline object activity [options] [command]List manually-logged activities for a row
frontline object activity list [options] <object> <row-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create an activity on a row
frontline object activity create [options] <object> <row-id>Options
| Flag | Description | Default |
|---|---|---|
--content <text> | Activity content (required) | |
--type <type> | Activity type: NOTE (default), EMAIL, PHONE_CALL, MEETING, WHATSAPP | |
--activity-date <date> | When the activity happened (ISO date/datetime, defaults to now) | |
--user-ids <ids> | Comma-separated user IDs to tag as attendees/participants (e.g. 12,34) | |
--related-table-id <id> | Numeric table/object ID to link to another record (pair with --related-row-id) | |
--related-row-id <id> | Row ID of the linked record (pair with --related-table-id) | |
--additional-data <json> | Extra metadata as JSON (e.g. '{"duration":30}') | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get a specific activity by ID
frontline object activity get [options] <object> <activity-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update an activity
frontline object activity update [options] <object> <activity-id>Options
| Flag | Description | Default |
|---|---|---|
--content <text> | New content | |
--activity-date <date> | Update the activity date (ISO date/datetime) | |
--user-ids <ids> | Comma-separated user IDs to replace the participant list | |
--related-table-id <id> | Update the linked table ID (omit or pass empty to clear) | |
--related-row-id <id> | Update the linked row ID (omit or pass empty to clear) | |
--additional-data <json> | Replace extra metadata (JSON, empty string to clear) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete an activity (only manual activities; only owner or admin)
frontline object activity delete [options] <object> <activity-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Read the full record activity timeline (synced emails, chats, audit, notes) — permission-redacted server-side
frontline object timeline [options] [command]List the full activity timeline for a row (synced emails, chats, audit, notes)
frontline object timeline list [options] <object> <row-id>Options
| Flag | Description | Default |
|---|---|---|
--type <types> | Comma-separated activity types: EMAIL, CONVERSATION, WHATSAPP_PERSONAL, AUDIT_LOG, NOTE, TASK, FILE, MANUAL_ACTIVITY | |
--search <query> | Free-text search across the timeline | |
--from <date> | Only activities on/after this date (ISO date/datetime) | |
--to <date> | Only activities on/before this date (ISO date/datetime) | |
--page <n> | Page number (default 1) | |
--page-size <n> | Results per page (default 50, max 200) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get full detail for a single timeline activity
frontline object timeline get [options] <object> <row-id> <activity-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage tasks on object rows
frontline object task [options] [command]List tasks for a row
frontline object task list [options] <object> <row-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a task on a row
frontline object task create [options] <object> <row-id>Options
| Flag | Description | Default |
|---|---|---|
--content <text> | Task content (required) | |
--type <type> | Task type: TASK (default), PHONE_CALL, SEND_WHATSAPP, SEND_EMAIL, or SEND_SMS | |
--due-date <date> | Due date (ISO 8601) | |
--assignees <ids> | Comma-separated user IDs | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get a specific task by ID
frontline object task get [options] <object> <task-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update a task
frontline object task update [options] <object> <task-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Updated task data (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Mark a task as completed
frontline object task complete [options] <object> <task-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Mark a task as uncompleted
frontline object task uncomplete [options] <object> <task-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete a task
frontline object task delete [options] <object> <task-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage files attached to object rows
frontline object file [options] [command]List files for a row
frontline object file list [options] <object> <row-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get file metadata by ID
frontline object file get [options] <object> <file-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Download a file by ID
frontline object file download [options] <object> <file-id>Options
| Flag | Description | Default |
|---|---|---|
--output <path> | Output file path | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Upload a file for an object row
frontline object file upload [options] <object> <row-id> <file-path>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete a file
frontline object file delete [options] <object> <file-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage view aggregations
frontline object aggregation [options] [command]List aggregations for a view
frontline object aggregation list [options] <object> <view-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create an aggregation on a view
frontline object aggregation create [options] <object> <view-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Aggregation definition (JSON: {columnId, operation, tagId?}) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update an aggregation's operation
frontline object aggregation update [options] <object> <view-id> <agg-id>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Update payload (JSON: {operation}) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete an aggregation
frontline object aggregation delete [options] <object> <view-id> <agg-id>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Compute aggregation values for a view
frontline object aggregation compute [options] <object> <view-id>Options
| Flag | Description | Default |
|---|---|---|
--query <json> | Filter query (JSON) | |
--search <term> | Full-text search | |
--column-id <id> | Specific column ID to compute | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Preview formula expressions on an object
frontline object formula [options] [command]Preview a formula calculation on an object
frontline object formula preview [options] <object>Options
| Flag | Description | Default |
|---|---|---|
--data <json> | Preview definition (JSON) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |