---
title: "Subscription lists listing"
method: GET
path: "/api/subscription_lists"
tags: ["Subscription Lists"]
---

# Subscription lists listing

`GET /api/subscription_lists`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/subscription_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/subscription_lists/get.ts> (a function with typed inputs; its response is checked against the schema)

Provides a list of subscription lists IDs that are associated with this app key.

## Response `200`

Returns OK for success, with the list of subscription lists for the app.

- object
  - `ok` boolean: Success.
  - `subscription_lists` SubscriptionListResultObject[]: An array of subscription list result objects.
    - `default_opted_in` boolean, required: `True` if the audience defined by `scopes` are opted in by default, otherwise `false`.
    - `description` unknown
    - `list_id` string, required: A list ID that contains only alphanumeric characters, underscores, or hyphens.
    - `message_type` 'transactional' | 'commercial': The message type.
    - `name` string: Human readable name.
    - `scopes` Scopes[], required: An array of scopes applicable to the subscription list. Valid scopes are `app`, `web`, `email`, and `sms`.

## Other responses

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

## Changes

- **2022-04-12** `5a2789287bfb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/airship/apis/airship-api/changes/api/subscription_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)