Accounts search

The account search API lets you find, filter, and analyze customer or company accounts using flexible Typesense-powered queries. You can search by text, filter by any account property, and select exactly which fields you want in the response.

Note: Fallback search mode is not supported for accounts. Only primary search mode is available.

Example use cases

• Get all active accounts in the technology industry

  {
    "query_by": "name,description",
    "filter_by": "is_active:=true&&industry:=technology",
    "q": "*"
  }
  

• Find accounts with more than 1000 employees

  {
    "query_by": "name",
    "filter_by": "employees:>1000",
    "q": "*"
  }
  

• List accounts created in the last 90 days

  {
    "query_by": "name",
    "filter_by": "created_at:>2024-03-01",
    "q": "*"
  }
  

• Get accounts with a specific account owner

  {
    "query_by": "name",
    "filter_by": "account_owner_email:=[e-mail]",
    "q": "*"
  }
  

• Find accounts with the word ‘acme’ in the name or description

  {
    "query_by": "name,description",
    "q": "acme"
  }
  

---

Account search response fields

Below are all the fields you may see in an account search result. Many are optional and will only appear if included in your include_fields parameter.

Field	Type	Description
uid	string	Unique account identifier
name	string	Account name
description	string	Account description
is_active	boolean	Whether the account is active
logo	string	Logo URL or identifier
status	number	Status code
classification	number	Classification code
health	number	Health score/code
industry	number	Industry code
source	string	Source of the account
primary_domain	string	Primary domain
secondary_domain	string	Secondary domain
annual_revenue	number	Annual revenue
employees	number	Number of employees
website	string	Website URL
billing_address	string	Billing address
shipping_address	string	Shipping address
account_owner_id	number	Account owner ID
account_owner_email	string	Account owner email
account_owner_name	string	Account owner name
account_owner_user_type	string	Account owner user type
account_owner_status	string	Account owner status
account_owner_timezone	string	Account owner timezone
metadata	string	Custom metadata
organization_id	number	Organization ID
created_at	string	Creation timestamp (ISO8601)
updated_at	string	Last update timestamp (ISO8601)
deleted_at	string	Deletion timestamp (ISO8601)
organization_uid	string	Organization UID

For a full list, see the AccountSearchResponseDto in the API reference.

---

Tip: Use the include_fields parameter to limit the response to only the fields you need for performance and clarity.