A/B Tests6

Attribute Lists4

Automation11

Bulk Sending7

Channels6

Contacts6

Content8

Custom Events1

Email10

Journeys2

Named Users8

OAuth2

Open Channels3

Personalization8

Push4

Regions2

Reports21

Schedules7

Segments5

SMS8

Static Lists7

Subscription Lists2

Tag Lists5

Tags1

Static Lists

Retrieve lists

Changed on Aug 28, 2025

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

get/api/lists

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2
  Client credentials
  Token URLhttp://oauth2.{domain}.com/token
  Scopeslst
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/lists/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

Lists metadata retrieved successfully.

okboolean

Success.

Changes

Aug 28, 20253304568aaadc Revision changes
- breaking
  the // response property's maxLength was increased from 1000 to 10000 for the response status
This list may be incomplete.

Operation history