contacts

List the contacts of an organization

Newest first. search is a full-text search over the name, and extra_data filters by your own fields — which is what makes it possible to ask for "the contacts of this campaign" without keeping a second database.

get/organizations/{id_organization}/contacts

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/contacts
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Query parameters

offsetinteger

Records to skip (pagination)

limitinteger

Records per page (pagination)

searchstring

Full-text search over the contact's name.

social_network'facebook' | 'instagram' | 'linkedin' | 'tiktok' | 'twitter' | 'whatsapp' | 'youtube' | 'google_business' | 'bluesky' | 'discord' | 'telegram' | 'threads' | 'slack' | 'pinterest'

A social network supported by PlanVortex.

This list grows. Treat it as an open enumeration: a client that rejects an unknown value breaks the day a network is added, which happens several times a year. Not every network does everything — ask GET /social_capabilities.

Only the contacts reachable on this network. It matches on social_identifiers[].social_network, so a contact with several channels comes back through any of them. It used to return an empty list always, because the server compared the whole array of objects against the network name; that was fixed on 2026-08-24.

keystring
valueunknown

Filter by your own fields, as key/value pairs. A value that is an array matches any of its entries.

Response

Contacts

totalinteger required

Changes

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