AIairship
Channels

Channel listing

Changed on

List all channels registered to this app key, along with associated data and metadata.

get/api/channels

Request

Query parameters

limitinteger

The default limit is 1,000 channel objects returned per request. Set the limit to 1,000 or fewer in your API calls.

Response

Returns OK for success with the JSON response. Tags added to a channel using /named_users/tags are not returned from this endpoint. To view those tags, you must look up the named user associated with the channel.

next_pagestring url

If there is more than one page of results, use this link to get the next page of results.

okboolean

Success.

Example response

{
  "channels": [
    {
      "address": "email@example.com",
      "channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5",
      "email_address": "name@example.com",
      "ios": {
        "quiettime": {
          "end": "07:30",
          "start": "21:30"
        },
        "tz": "America/Los_Angeles"
      },
      "msisdn": "15035556789",
      "named_user_id": "john_doe",
      "open": {
        "identifiers": {
          "slack-handle": "slackinator"
        },
        "open_platform_name": "Slack"
      },
      "opt_in_date": "2022-07-07T03:23:13",
      "opt_out_date": "2022-07-08T03:23:13",
      "push_address": "FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660",
      "subscription_lists": [
        {
          "action": {
            "list_id": "90s_rap_videos"
          },
          "list_id": "90s_rap_videos"
        }
      ],
      "tags": [
        "Federer fan",
        "Messi fan"
      ]
    }
  ],
  "next_page": "https://go.urbanairship.com/api/channels?limit=1000&start=535ec31e-4b07-4b26-bead-a1c0e94e133c"
}

Changes

  • bd6ab947117aRevision changes
    • breaking

      added subschema #1: Channel subscription list action to the //// response property oneOf list for the response status

    This list may be incomplete.

  • 38241778b0c1Revision changes
    • warning

      removed the optional property // from the response with the status

    This list may be incomplete.