Skip to content

frontline user-tasks

Manage user tasks — the account 'To-dos' inbox (optionally linked to an object record)

frontline user-tasks [options] [command]

Options

FlagDescriptionDefault
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline user-tasks list

List user tasks (the To-dos inbox)

frontline user-tasks list [options]

Options

FlagDescriptionDefault
--mineOnly tasks assigned to you
--completedOnly completed tasks
--pendingOnly open (not completed) tasks
--type <type>Filter by task type: TASK, PHONE_CALL, SEND_WHATSAPP, SEND_EMAIL, or SEND_SMS
--object <name>Only tasks linked to this object (e.g. companies)
--people <csv>Filter by People record IDs (comma-separated)
--teams <csv>Filter by team IDs (comma-separated)
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline user-tasks create

Create a user task

frontline user-tasks create [options]

Options

FlagDescriptionDefault
--content <text>Task content / title
--type <type>Task type: TASK (default), PHONE_CALL, SEND_WHATSAPP, SEND_EMAIL, or SEND_SMS
--due <date>Due date (YYYY-MM-DD)
--assignees <csv>Assignee user IDs (comma-separated; see 'frontline users list')
--object <name>Link to an object (requires --row)
--row <rowId>Linked object record ID (requires --object)
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline user-tasks get

Get a user task by ID

frontline user-tasks get [options] <taskId>

Options

FlagDescriptionDefault
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline user-tasks update

Update a user task (only the fields you pass)

frontline user-tasks update [options] <taskId>

Options

FlagDescriptionDefault
--content <text>New content
--type <type>New task type: TASK, PHONE_CALL, SEND_WHATSAPP, SEND_EMAIL, or SEND_SMS
--due <date>New due date (YYYY-MM-DD)
--clear-dueClear the due date
--assignees <csv>Replace assignees with these user IDs (comma-separated)
--object <name>Link to an object (requires --row)
--row <rowId>Linked object record ID (requires --object)
--unlinkRemove the linked object record
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline user-tasks complete

Mark a user task as completed (you must be an assignee)

frontline user-tasks complete [options] <taskId>

Options

FlagDescriptionDefault
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline user-tasks uncomplete

Reopen a completed user task

frontline user-tasks uncomplete [options] <taskId>

Options

FlagDescriptionDefault
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline user-tasks delete

Delete a user task

frontline user-tasks delete [options] <taskId>

Options

FlagDescriptionDefault
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)