CLI

CRM CLI

Read CRM accounts, contacts, deals, and leads from the Bigmind CLI.

CRM CLI commands let you inspect CRM records that the signed-in Bigmind user can access. The CLI uses Bigmind's application permission policies, so returned records match the user's configured CRM visibility.

#Object types

CRM commands support these object types:

  • accounts
  • contacts
  • deals
  • leads

#List records

List records for an object type:

bigmind api crm accounts list
bigmind api crm contacts list
bigmind api crm deals list
bigmind api crm leads list

Use limit and cursor query parameters for pagination:

bigmind api crm accounts list --query limit=25
bigmind api crm deals list --query limit=25 --query cursor=25

#Filter records

Pass a filter payload with --json. Filters use the same logical structure as Bigmind CRM list views.

bigmind api crm accounts list \
  --query limit=25 \
  --json '{"filters":{"operator":"AND","conditions":[]}}'

A filter condition includes the field name, object type, operator, and value:

bigmind api crm accounts list \
  --json '{"filters":{"operator":"AND","conditions":[{"name":"name","type":"crm-account","operator":"contains","value":"Acme"}]}}'

#Get a record

Fetch a single CRM record by ID:

bigmind api crm accounts get acc_123
bigmind api crm contacts get con_123
bigmind api crm deals get deal_123
bigmind api crm leads get lead_123

#Aliases

Singular aliases are accepted:

bigmind api crm account get acc_123
bigmind api crm deal get deal_123
Updated 5/26/2026