Count people

Counts the people a search would find, without listing them. Send exactly one of query, filters, savedSearchId or savedSearchName, as the search takes them.

A new count runs in the background: the first answer is 202 with status pending. Send the same request again every few seconds until it answers 200 with status ready and the total. A count takes up to about a minute and a half.

Free. Scope: search. Read-only keys may call it.

POST /v1/people/count

Count people

cURL

curl --request POST \
  --url https://api.outbound.dev/v1/people/count \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "job_title_levels": [
      "director",
      "vp"
    ],
    "job_title_role": [
      "operations"
    ]
  }
}
'

200

{
  "status": "ready",
  "total": 1246019,
  "filters": {
    "job_title_levels": [
      "director",
      "vp"
    ],
    "job_title_role": [
      "operations"
    ]
  }
}

Authorizations

Authorization · string · header · required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Body

application/json

query · string

Who to find, in plain language. It is turned into filters, which the page answers with as filters.

Required string length: 1 - 2000

Example:

"operations directors at logistics companies in Portugal"

filters · object

Filters by name, with values from GET /v1/people/filters and GET /v1/people/autocomplete.

Show child attributes

Example:

{
  "job_title_levels": ["director", "vp"],
  "job_title_role": ["operations"]
}

savedSearchId · string

Run a saved people search by its id.

Required string length: 24

Pattern: ^[0-9a-fA-F]+$

savedSearchName · string

Run a saved people search by its title. A title several saved searches share answers 409 saved_search_name_ambiguous.

Required string length: 1 - 255

Response

200

application/json

The count is ready.

status · enum<string> · required

Available options: ready

total · integer · required

How many match.

filters · object · required

The filters counted. Send them to the search to list the matches.

unresolvedCriteria · string[]

With query: the parts of it that could not be turned into a filter.

closestCompanyMatches · object[]

With query: each company it named that the search chose between same-named companies for, and the one chosen.

Show child attributes

ignoredFilterKeys · string[]

With a saved search: stored filters the search no longer takes, left out.

unappliedCompanyNames · object[]

Company names in the filters the search could not apply yet, by filter.