---
title: "Get Or Create Crm List"
method: POST
path: "/integrations/crm/lists"
tags: ["Integrations"]
---

# Get Or Create Crm List

`POST /integrations/crm/lists`

## Request

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

Get, or create, a list IN THE CUSTOMER'S CRM, matched by name.

IDEMPOTENT: calling twice with the same name returns the existing list
rather than making a second one, which is what makes it safe to call before
every membership change. 200, not 201, because most calls return a list
that already existed.

The app takes these three as query parameters on a POST; they are a body
here, because a POST carrying its arguments in the query string is not a
shape to put in a public contract.

## Headers

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

## Request body

- GetOrCreateCrmListRequest: Get, or create, a list in the CUSTOMER'S CRM, matched by name. Not a mirror - the app takes these three as QUERY parameters on a POST, which is not a shape to publish. The field names and meanings are the handler's.
  - `name` string, required: List name. Matched in the CRM; created when absent.
  - `connection_id` string, required
  - `entity_type` 'contacts' | 'companies' | 'deals' | 'leads', nullable: Which object the list holds. Omit for `contacts`.

## Response `200`

Successful Response

- ApiResponseCrmPayload
  - `data` CrmPayload, required: One CRM record, or one provider response. Open-shaped ON PURPOSE. These bodies carry whatever the provider returned, the field set differs between HubSpot, Salesforce, Pipedrive and SugarCRM, and it grows every time one of them ships something. Pinning it would drop whatever a provider reported that this contract had not caught up on - which on a CRM surface means silently hiding the customer's own data from them.
  - `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/2e7cfa0ca921?raw)