AIairship
Named Users

Named user listing or lookup

Changed on

Return a list of named users or look up a single named user by named_user_id.

get/api/named_users

Request

Response

Returns OK for success.

OR

Example response

{
  "named_user": {
    "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"
        ]
      }
    ],
    "named_user_id": "john_doe",
    "subscription_lists": [
      {
        "list_ids": [
          "example_listId-1",
          "example_listId-5"
        ]
      }
    ]
  }
}

Changes

  • bd6ab947117aRevision changes
    • breaking

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

    • 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
    • breaking

      added subschema #1: Named user lookup response object subschema #2: Named user listing response body to the response body oneOf list for the response status

    • info

      removed subschema #1: Named User lookup response object subschema #2: Named User listing response body from the response body oneOf list for the response status

    This list may be incomplete.