---
title: "GET /v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists"
method: GET
path: "/v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists"
tags: ["advertisers"]
---

# GET /v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists

`GET /v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists`

## Request

- Base URL: `https://displayvideo.googleapis.com`
- URL: `https://displayvideo.googleapis.com/v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/display-video`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/display-video`
- TypeScript: <https://skmtc.dev/google/apis/displayvideo/docs/v4/advertisers/:advertisersId/reachForecast:retrievePlannableUserLists/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves first and third party user lists available for forecasting. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users.

## Path parameters

- `advertisersId` string, required

## Query parameters

- `filter` string
- `pageSize` integer
- `pageToken` string

## Response `200`

Successful response

- RetrievePlannableUserListsResponse: Response for RetrievePlannableUserLists.
  - `nextPageToken` string: Output only. A token to retrieve the next page of results.
  - `plannableUserLists` PlannableUserList[]: Output only. The list of plannable user lists.
    - `displayName` string: Output only. The display name of the user list.
    - `name` string: Output only. The resource name identifying the user list. Format: `advertisers/{advertiser_id}/userLists/{user_list_id}`
    - `plannableStatus` 'PLANNABLE_STATUS_UNSPECIFIED' | 'PLANNABLE' | 'UNPLANNABLE': Output only. The plannability status of the user list.
    - `userListType` 'USER_LIST_TYPE_UNSPECIFIED' | 'FIRST_PARTY' | 'THIRD_PARTY': Output only. The type of the user list.

---

[API](https://skmtc.dev/google/apis/displayvideo.md) - [All operations](https://skmtc.dev/google/apis/displayvideo/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/displayvideo/revisions/d80b56b6703a?raw)
