Skip to main content

​
Global flags

FlagPurpose
--api-keyUse a specific Developer API key.
--base-urlOverride the API base URL.
--orgTarget an organization.
--workspaceTarget a workspace.
--jsonEmit compact JSON.
--prettyEmit formatted JSON.
--dataProvide a JSON request body.
--data-fileLoad a JSON request body from disk.
--idempotency-keyAdd an idempotency key for retryable mutations.
--dry-runPreview a request without sending it.
--confirmRequired for destructive commands.

​
Command groups

The CLI registry is committed at data/cli-commands.json and is used to keep docs aligned with implementation. Launch groups include:
  • whoami, doctor
  • orgs, organizations, workspaces
  • campaigns
  • contacts, contact-lists, contact-tags, contact-imports, contact-exports
  • inbox
  • connectors
  • kb
  • offerings
  • tracking-domains
  • billing
  • members, invitations, groups, domains
  • api-keys

​
Examples

firstsales campaigns list --org org_123 --workspace ws_123 --json
firstsales contacts create --org org_123 --workspace ws_123 --data '{"email":"alex@example.com"}' --idempotency-key import-row-001
firstsales contacts delete --org org_123 --workspace ws_123 --contact contact_123 --confirm