v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Accounts

Search for Accounts

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo. Use the Search for Accounts endpoint to search for an account that has been saved to Apollo. This endpoint only returns accounts in the search results. To search for companies in Apollo, call the <a href="https://docs.apollo.io/reference/organization-search">Organization Search endpoint</a>. To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.

post/accounts/search

Request body

q_organization_namestring

Add keywords to narrow the search of the accounts in your team's Apollo account. Keywords should directly match at least part of an account's name. For example, searching the keyword marketing might return the result NY Marketing Unlimited, but not NY Market Analysts. This parameter only searches account names, not other account fields. Examples: apollo; microsoft; marketing

account_stage_idsstring[]

The Apollo IDs for the account stages that you want to include in your search results. If you add multiple account stages, Apollo will include all accounts that match any of the stages, along with the other parameters, in the search results. Call the List Account Stages endpoint to retrieve a list of all the account stage IDs available in your Apollo account. Example: 61b8e913e0f4d2012e3af74e

account_label_idsstring[]

The Apollo IDs for the labels that you want to include in your search results. If you add multiple labels, Apollo will include all accounts connected to any of the labels, along with the other parameters, in the search results. Example: ['6095a710bd01d100a506d4ae']

sort_by_field'account_last_activity_date' | 'account_created_at' | 'account_updated_at'

Sort the matching accounts by 1 of the following options:

account_last_activity_date: The most recent activity date recorded first.
account_created_at: The most recently created first.
account_updated_at: The most recently updated first.

sort_ascendingboolean

Set to true to sort the matching accounts in ascending order. This parameter must be used with sort_by_field. Otherwise, the sorting logic is not applied. Example: true

pageinteger

The page number of the Apollo data that you want to retrieve. Use this parameter in combination with the per_page parameter to make search results navigable and improve the performance of the endpoint. Example: 4

per_pageinteger

The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance. Use the page parameter to navigate through the different pages of data. Example: 10

Response

200

partial_results_onlyboolean

has_joinboolean

disable_eu_prospectingboolean

partial_results_limitinteger

{"stackTrail":"paths:/accounts/search:post:responses:200:content:application/json:schema:properties:num_fetch_result","oasType":"schema","type":"unknown"}

Example response

{
  "breadcrumbs": [
    {
      "label": "Company Name",
      "signal_field_name": "q_organization_name",
      "value": "Irish Copywriters",
      "display_name": "Irish Copywriters"
    }
  ],
  "partial_results_limit": 10000,
  "pagination": {
    "page": 1,
    "per_page": 5,
    "total_entries": 1,
    "total_pages": 1
  },
  "accounts": [
    {
      "id": "66e9abf95ac32901b20d1a0d",
      "domain": "irishcopywriters.com",
      "name": "The Fast Irish Copywriters",
      "team_id": "6095a710bd01d100a506d4ac",
      "account_stage_id": "61b8e913e0f4d2012e3af74e",
      "source": "api",
      "original_source": "api",
      "owner_id": "66302798d03b9601c7934ebf",
      "created_at": "2024-09-17T16:19:05.663Z",
      "phone": "555-555-0172",
      "phone_status": "no_status",
      "sanitized_phone": "+15555550172",
      "existence_level": "full",
      "modality": "account",
      "source_display_name": "Created from API"
    }
  ]
}