People

Search people

Searches people on each platform as one of the team's account links, like the platform's own search box.

Needs the Advanced API add-on, and directory:typeahead on each account link. Each account link can search 20 times per minute, 300 per hour and 1500 per day, so the platform doesn't flag its session; past a limit, it is listed in failures with peopleSearchRateLimited.

Use the result's target to reach that person on endpoints like Send message or Send connection request.

get/people

Request

  • Base URL: https://inboxapp.com/api/v2
  • URL: https://inboxapp.com/api/v2/people
  • Auth: HTTP bearer

Query parameters

platformPlatform[]

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.

[
  "twitter"
]
accountLinkIdCuid2[]

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.

qstring required

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

reach'contacts' | 'network'

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

enrichboolean

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

Example response

{
  "data": [
    {
      "profile": {
        "platform": "twitter",
        "username": "jane",
        "handle": "@jane",
        "platformCreatedAt": "2026-09-14T10:32:00.000Z",
        "updatedAt": "2026-09-14T10:32:00.000Z",
        "relationships": [
          {
            "connectionRequest": {
              "sentAt": "2026-09-14T10:32:00.000Z"
            }
          }
        ]
      },
      "target": {
        "platform": "twitter"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.