v1

latestOpenAPI 3.1.02026-07-246026.9 KB

Retrieve Push Subscribers

Retrieve a paginated list of push subscriber user_id values for a specified platform. Each response returns up to 1000 results.

To retrieve all subscribers, make repeated requests passing the offset value from each response until offset returns null.

The list may include duplicate user_id values when multiple users share the same custom user ID.

get/users/subscribers/

platform'android' | 'ios' | 'web' required

Example:web

Required. The platform to retrieve push subscribers for (case-sensitive).

offsetstring

Example:5ec8e357e68090fe4bde27ac

The pagination cursor returned in the previous response. Omit on the initial request.

appidstring required

Example:<YOUR_APP_ID>

Required. Your AIQUA app ID.

authorizationstring required

Example:Token <YOUR_API_TOKEN>

Required. Your AIQUA API token. Must start with "Token".

Success

statusstring

datastring[]

A list of push subscriber user_id values.

offsetstring nullable

The cursor to pass in the next request to retrieve the next batch. Returns null when all results have been retrieved.

{
  "status": "success"
}