---
title: "Retrieve lists"
method: GET
path: "/api/attribute-lists"
tags: ["Attribute Lists"]
---

# Retrieve lists

`GET /api/attribute-lists`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/attribute-lists`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `http://oauth2.{domain}.com/token` scopes: `lst`
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/attribute-lists/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve information about all attributes lists. This call returns a list of metadata that will not contain the actual lists of users.

## Response `200`

Lists metadata retrieved successfully.

- object
  - `lists` ListObject[]: An array of list objects.
    - `channel_count` integer: A count of resolved channel identifiers for the last uploaded and successfully processed identifier list. This will always be 0 for attribute lists.
    - `created` string, date-time: The [date-time](/developer/rest-api/ua/introduction/#date-time-format) when the list was initially created.
    - `description` string: An optional description for the list.
    - `error_path` string: If non-empty, indicates that there were errors in the processed CSV file. The value is either an empty string or a URL to download a file describing the errors.
    - `extra` unknown
    - `last_updated` string, date-time: The [date-time](/developer/rest-api/ua/introduction/#date-time-format) when the identifiers of the list were last updated successfully.
    - `name` string, required: The name of the list, consists of up to 64 URL-safe characters. The name is how the list is identified, so it should be unique and memorable.
    - `status` 'ready' | 'processing' | 'failure': A string value representing the state of the list. * `ready` — The list was processed successfully and is ready for sending. * `processing` — The list is being processed. * `failure` — There was an error processing the last uploaded list.
  - `ok` boolean: Success.

## Other responses

- `401`: Authentication information (the app key and secret or bearer token) was either incorrect or missing.

## Changes

- **2025-08-28** `3304568aaadc`: 1 breaking
  - the `lists/items/description` response property's maxLength was increased from `1000` to `10000` for the response status `200`
  - …this revision’s changelog is incomplete

[Operation history](https://skmtc.dev/airship/apis/airship-api/changes/api/attribute-lists/get.md)

---

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