Search for collections of people

post

https://gotlivedata.io/api/people/v1/{org_id}/search

Search for people in Live Data that match the specified filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

org_id

string

required

Your Org ID

Body Params

filters

array of objects

filters

return_fields

array of strings

List of field names to return. For nested JSON fields, use dot notation (i.e. jobs.company.name)

return_fields

past_jobs

integer

How many previous jobs to include in the data

size

integer

The number of records to return in each page of the search. Defaults to 10.

pagination_token

string

If provided, returns the next page of data based on the pagination_token.

The pagination_token is only valid for a given set of filters/size -- the same filters and size must be supplied for every call using the pagination_token from a response with those filters. If the filters/size don't match the pagination_token, this call will return a 400.

sort_by

string

Which field to sort on. Use the pattern +name to sort ascending and -name to sort descending.

aggs

array of objects

aggs

report

object

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

402Payment Required