Fetch Contacts
POST /contacts/fetch
Page through contacts, projecting only the columns you name.
A POST because the filter is a body, not because it writes: this reads and mutates nothing, and is tiered as a read so a read-only key can call it.
Prefer this over GET /contacts when you want a narrow column set -
naming the columns lets the planner drop joins the full row forces.
Authorizations
Parameters
Header Parameters
Request Body required
Page through contacts, optionally projecting a narrow column set.
mapping_columns is not only a smaller payload: naming a narrow set lets
the planner drop joins the full row would force, so it is materially
cheaper on a wide org.
object
Records per page.
Page number (1-indexed).
Responses
200
Successful Response
object
An open envelope for a LIST result, so a bare list keeps its shape.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error