Skip to main content
GET
Search people

Query Parameters

platform
string[]

Searches these platforms. Defaults to every available platform. With accountLinkId, keeps only the account links on these platforms. Repeat the key to match any of several.

The platform. Every team can use twitter, linkedin; a team may have others enabled.

Searches from these account links. Each platform is searched once, from the oldest account link given on it; IDs that match no account link are ignored. Without it, each platform is searched from its oldest active account link that can search. Repeat the key to match any of several.

Pattern: ^[0-9a-z]+$
q
string
required

A name or username, as typed into the platform's own people search.

Required string length: 1 - 100
reach
enum<string>

contacts, the default, searches people each account already messages. network also searches beyond them, where the platform separates the two.

Available options:
contacts,
network
enrich
boolean

true fetches and stores every result Inboxapp hasn't stored yet, so each comes back as a full profile. A result that can't be fetched or stored is left out. Slower. Defaults to false.

Response

OK

Every searched account link's results in one list: closest name or username match first, then people the account already talks to or is connected with, then verified, then each platform's own order. Not paginated.

data
object[]
required
failures
object[]
required

The searched account links that returned nothing. When every one fails, the request fails with the first one's error instead.