Contacts

Find contacts

Finds contacts by the platform identity of one of their profiles: a platform with platformId or username.

get/contacts

Request

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

Query parameters

platformPlatform[]

Contacts with a profile on these platforms. Defaults to every platform available to the team. platformId needs exactly one. Repeat the key to match any of several.

[
  "twitter"
]
platformIdstring[]

Contacts with a profile of this platform ID. Give one of platformId, username or q, repeating the key for up to 100. No match is an empty page.

usernamestring[]

Contacts with a profile of this username, without its display prefix. One username may match several contacts. Give one of platformId, username or q, repeating the key for up to 100. No match is an empty page.

qstring

Searches contact and profile names, usernames, emails and phone numbers. Not combinable with platformId or username. Results follow createdAt, not relevance, and can trail changes by a few seconds.

expandstring[]

Related resources to embed next to their ID field, one path per key, at most 4.

limitinteger

Page size, from 1 to 100. Defaults to 50.

cursorstring

The previous page's nextCursor. Opaque, and valid only with the filters it was issued for.

Response

OK

nextCursorstring nullable required

Pass it back as cursor, with the same filters, to read the next page. Null on the last page.

Example response

{
  "data": [
    {
      "profiles": [
        {
          "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"
              }
            }
          ]
        }
      ],
      "createdAt": "2026-09-14T10:32:00.000Z",
      "updatedAt": "2026-09-14T10:32:00.000Z",
      "status": {
        "color": "#3b82f6",
        "createdAt": "2026-09-14T10:32:00.000Z"
      },
      "tags": [
        {
          "color": "#3b82f6"
        }
      ],
      "assignee": {
        "createdAt": "2026-09-14T10:32:00.000Z"
      }
    }
  ]
}

Changes

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