Skip to main content
POST
Price a population search
A population search returns everyone in one population: every current employee of a company, or everyone who attended a school. Price it first, then start it with Search a population.

Request body

Response

Authorizations

Authorization
string
header
required

Use an Orbit API key from the developer dashboard.

Body

application/json
population
object
required
size
integer | null

How many people the population has, when you know it.

Required range: x >= 0
profile_depth
enum<string>
default:partial

The depth every person in the population is built to.

Available options:
partial,
full

Response

The quote.

population
object
required
size
integer | null
required

The population's size as given, or null.

profile_depth
enum<string>
required

The depth the quote priced.

Available options:
partial,
full
credits
integer
required

The whole cost of the search, as one number. Reserved when the search starts.

max_people
integer
required

The most people one population search covers.

pricing_version
string
required

The pricing catalog version the quote used.