v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Get Accounts

Retrieve accounts (companies/organizations) with optional filtering, sorting, and pagination.

Accounts represent business entities such as customers, vendors, or partners. Without filters, returns the most recent accounts sorted newest first.

Query Parameters:

  • match_filter_dict (optional): JSON-encoded MongoDB query. Must use exact database field names — do not use pseudo-fields like created_at. Filterable fields include: status, source, relationship_type, name, company_name, industry, tags, email_list, phone_list. Examples:
    • {"status": "customer"} — active customers
    • {"relationship_type": "vendor"} — vendor accounts
    • {"industry": "technology"} — tech-sector accounts
  • eval_object_id (default: false): Set to true when using ObjectId('...') syntax in filters.
  • sort_dict (default: {"_id": -1}): JSON-encoded sort criteria.
  • page_size (default: 50): Number of records per page.

Response: Array of account objects with id, name, status, source, relationship_type, company_name, industry, num_employees, contact info, dates, tags, and social profiles.

get/crm/accounts

Query parameters

match_filter_dictstring
eval_object_idboolean
sort_dictstring
page_sizeinteger

Response

Successful Response

idstring required
namestring required
statusstring nullable
sourcestring nullable
relationship_typestring nullable
websitestring nullable
company_namestring nullable
descriptionstring nullable
industrystring nullable
num_employeesinteger nullable
tagsstring[] nullable
social_dict_listobject[] nullable
created_datestring nullable
updated_datestring nullable