Contacts

Bulk Get Contacts

Full records for up to 100 contacts in ONE request. Writes nothing.

Use this instead of looping GET /contacts/{contact_id}: GET /contacts returns a lean summary per contact, and the loop spends one rate-limit slot per contact to get the other fields. Each item is exactly what the per-contact route returns, through the same access check. A contact that does not exist or is outside the key's scope comes back found: false, rather than failing the batch. POST only because the ids are a body; it is tiered as a read.

post/contacts/bulk-get

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/contacts/bulk-get
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

contact_idsinteger[] required

Up to 100 contact ids, the ids GET /contacts returns. Duplicates are read once; the response keeps first-seen order.

include_custom_fieldsboolean

When true, each found contact includes a custom_fields object keyed by column slug, as GET /contacts/{contact_id}?include_custom_fields=true does.

Response

Successful Response

Changes