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:=owner@company.com",
  "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.

FieldTypeDescription
uidstringUnique account identifier
namestringAccount name
descriptionstringAccount description
is_activebooleanWhether the account is active
logostringLogo URL or identifier
statusnumberStatus code
classificationnumberClassification code
healthnumberHealth score/code
industrynumberIndustry code
sourcestringSource of the account
primary_domainstringPrimary domain
secondary_domainstringSecondary domain
annual_revenuenumberAnnual revenue
employeesnumberNumber of employees
websitestringWebsite URL
billing_addressstringBilling address
shipping_addressstringShipping address
account_owner_idnumberAccount owner ID
account_owner_emailstringAccount owner email
account_owner_namestringAccount owner name
account_owner_user_typestringAccount owner user type
account_owner_statusstringAccount owner status
account_owner_timezonestringAccount owner timezone
metadatastringCustom metadata
organization_idnumberOrganization ID
created_atstringCreation timestamp (ISO8601)
updated_atstringLast update timestamp (ISO8601)
deleted_atstringDeletion timestamp (ISO8601)
organization_uidstringOrganization 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.