---
title: "Get customer lists"
method: GET
path: "/ad_accounts/{ad_account_id}/customer_lists"
tags: ["customer_lists"]
---

# Get customer lists

`GET /ad_accounts/{ad_account_id}/customer_lists`

## Request

- Base URL: `https://api.pinterest.com/v5`
- URL: `https://api.pinterest.com/v5/ad_accounts/{ad_account_id}/customer_lists`
- Auth: OAuth 2
  - Authorization code: `https://www.pinterest.com/oauth/`
  - Token URL: `https://api.pinterest.com/v5/oauth/token` scopes: `ads:read`
- TypeScript: <https://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/ad_accounts/:ad_account_id/customer_lists/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a set of customer lists including id and name based on the filters provided.

(Customer lists are a type of audience.) For more information, see [Audience targeting](https://help.pinterest.com/en/business/article/audience-targeting) or the [Audiences](/docs/api-features/targeting-overview/) section of the ads management guide.

## Path parameters

- `ad_account_id` string, required

## Query parameters

- `bookmark` string
- `page_size` integer
- `order` 'ASCENDING' | 'DESCENDING'
- `exclude_nca` boolean

## Response `200`

The request has succeeded.

- object
  - `bookmark` string, nullable
  - `items` CustomerList[], required
    - `ad_account_id` string: Associated ad account ID.
    - `created_time` number: Creation time. Unix timestamp in seconds.
    - `exceptions` object: Customer list errors.
    - `id` string, required: Customer list ID.
    - `is_nca` boolean: Whether the list was uploaded for new customer acquisition (expanded matching). Immutable after creation.
    - `name` string, required: Customer list name.
    - `num_batches` number: Total number of list updates. List creation counts as one batch. Each [Append](/docs/redoc/#operation/ads_v3_customer_list_add_handler_PUT) or [Remove API](/docs/redoc/#operation/ads_v3_customer_list_remove_handler_PUT) call counts as another. List creation via the **Ads Manager** UI could result in more than one batch since the UI breaks up large lists.
    - `num_removed_user_records` number: Number of removed user records. In a [Remove API](/docs/redoc/#operation/ads_v3_customer_list_remove_handler_PUT) call, this counter increases even if the user is not found in the list.
    - `num_uploaded_user_records` number: Number of uploaded user records. In an [Append API](/docs/redoc/#operation/ads_v3_customer_list_add_handler_PUT) call, this counter increases even if the uploaded user is already in the list.
    - `status` 'PROCESSING' | 'READY' | 'TOO_SMALL' | 'UPLOADING': Customer list status. `TOO_SMALL` means the list has fewer than 100 Pinterest users.
    - `type` string: Always `customerlist`.
    - `updated_time` number: Last update time. Unix timestamp in seconds.

## Other responses

- `400`: The request could not be understood by the server due to unexpected data.
- `401`: Authentication is required and has either failed or not been provided.
- `403`: The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404`: The requested resource could not be found on this server.
- `429`: The user has sent too many requests in a given amount of time and is being rate limited.
- `default`: An unexpected error response.

## Changes

- **2026-06-04** (v5) `b698c180678a`: 2 breaking, 9 info
  - for the `query` request parameter `order`, default value `ASCENDING` was added
  - the response's body type changed from no type to `object` for status `200`
  - added the new optional `query` request parameter `exclude_nca`
  - removed `#/components/schemas/Paginated, subschema #2` from the response body `allOf` list for the response status `200`
  - …7 more
- **2024-04-23** (v5) `f9321315766f`: 1 breaking
  - the `allOf[subschema #2]/` response's property type changed from no type to `object` for status `200`
- **2022-11-14** (v5) `e041d7b0cef0`: 1 breaking, 1 info
  - for the `path` request parameter `ad_account_id`, the maxLength was decreased from `19` to `18`
  - for the `query` request parameter `page_size`, the max was increased from `100.00` to `250.00`
- **2022-09-07** (v5) `bd20b6eb152f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/ad_accounts/:ad_account_id/customer_lists/get.md)

---

[API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) - [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pinterest/apis/pinterest-rest-api/revisions/b698c180678a?raw)