Sign in
Admin Users

Get users list with pagination and filters

Retrieve a paginated list of users with optional filtering by search terms and explicit content flag

get/admin/users

Query parameters

pagenumber
Example:1

Page number (default: 1)

limitnumber
Example:10

Number of items per page (default: 10)

searchstring
Example:user@example.com

Search by Firebase User ID (exact match) or email (partial, case-insensitive)

useExplicitContentboolean
Example:true

Filter by explicit content flag (true/false)

isSubscribedboolean
Example:true

Filter by subscription status across all providers (Apple, Stripe, FunnelFox)

createdFromstring
Example:2024-01-01T00:00:00.000Z

Filter users created on or after this date (ISO 8601)

createdTostring
Example:2024-12-31T23:59:59.999Z

Filter users created on or before this date (ISO 8601)

isAnonymousboolean
Example:true

Filter by anonymous/demo user flag (true = demo users only)

useGiftSuggestionsboolean
Example:true

Filter by gift suggestions A/B flag (true = in experiment, false = control)

subscriptionSource'apple' | 'stripe' | 'funnelfox'

Filter by active subscription provider (apple | stripe | funnelfox)

cardFirst6string
Example:424242

Filter by card BIN (1-6 digits, prefix match). Combines with cardLast4; either may be used alone

cardLast4string
Example:4242

Filter by card last four (1-4 digits, suffix match). Combines with cardFirst6; either may be used alone

Response

Users list retrieved successfully

totalnumber required

Total number of users

pagenumber required

Current page number

limitnumber required

Number of items per page

totalPagesnumber required

Total number of pages

Example response

{
  "users": [
    {
      "id": "user-uuid-here",
      "firebaseUserId": "firebase-user-id",
      "email": "user@example.com",
      "phoneNumber": "+1234567890",
      "timezone": "America/Los_Angeles",
      "language": "en-US",
      "name": "Jane Doe",
      "fcmToken": "fcm-token-here",
      "appAccountToken": "app-account-token",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "isSubscribed": true,
      "autoRenewal": true,
      "subscriptionSource": "stripe"
    }
  ],
  "total": 150,
  "page": 1,
  "limit": 10,
  "totalPages": 15
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.