---
title: "Get Or Create Crm Audience"
method: POST
path: "/integrations/crm-sync/audiences"
tags: ["Integrations"]
---

# Get Or Create Crm Audience

`POST /integrations/crm-sync/audiences`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/integrations/crm-sync/audiences`
- Auth: HTTP bearer

Get, or create, the graph8 audience a CRM import lands in.

IDEMPOTENT BY TITLE. Calling twice with the same `list_name` returns the
same audience with `created: false` rather than making a second one, which
is what makes it safe to call before every import. That is the difference
from `POST /lists`, which always creates - and it is why this exists
separately rather than being folded into it.

The audience is tagged with the CRM provider and the connection it came
from, so a later sync can tell CRM-imported rows from graph8-native ones.

200, not 201: most calls return a list that already existed.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- CrmAudienceRequest: Get, or create, the graph8 audience a CRM import lands in. Idempotent by TITLE: calling twice with the same `list_name` returns the same audience with `created: false` rather than making a second one. That is what makes it safe to call before every import, and it is why this is not `POST /lists` - that one always creates.
  - `list_name` string, required: Audience title. Matched exactly; reused when it exists.
  - `connection_id` string, required: The CRM connection this audience is for. Its provider is recorded on the audience as the source and as a `crm-import` tag, which is what lets a later sync tell CRM-imported rows from graph8-native ones.
  - `entity_type` string, nullable: `contacts`, `companies`, `deals` or `leads`. Singular forms are accepted and pluralised by the app; anything unrecognised falls back to `contacts`. Omit for `contacts`.

## Response `200`

Successful Response

- ApiResponseCrmAudienceResponse
  - `data` CrmAudienceResponse, required: The audience, and whether this call is what created it.
    - `audience_id` integer, nullable
    - `title` string, nullable
    - `source` string, nullable
    - `created` boolean, nullable: True only when THIS call created the audience; false when it already existed.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)