Skip to main content
POST
/
api
/
v1
/
audience
Get Audience
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/audience/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "audience_id": 123
}
'
{
  "audience_id": 123,
  "audience_name": "<string>",
  "total_accounts": 123,
  "total_people": 123,
  "audience_type": "<string>",
  "account_ids": [],
  "audience_people": [
    {
      "person_id": 123,
      "person_name": "<string>",
      "person_role": "<string>",
      "person_email": "<string>",
      "person_location": "<string>",
      "person_linkedin_url": "<string>",
      "joined_company_at": "<string>",
      "person_crm_status": "<string>",
      "person_salesforce_contact_id": "<string>",
      "person_salesforce_owner_id": "<string>",
      "account_id": 123,
      "account_name": "<string>",
      "account_domain": "<string>",
      "direct_signals": [
        {}
      ]
    }
  ]
}

Headers

X-API-Key
string
required
X-User-ID
string
required

Body

application/json
audience_id
integer
required

Audience ID to get details for

Response

Successful Response

audience_id
integer
required
audience_name
string
required
total_accounts
integer
required
total_people
integer
required
audience_type
string | null
account_ids
integer[]
audience_people
AudiencePeople · object[] | null