Favicon

You are here: Home > API Reference > Platform > Otpusers > List OTP users with optional filtering

List OTP users with optional filtering

Required Permission: mad.store.otpUsers.list

Returns a paginated collection of OTP users scoped to the specified store.

GET
https://api.applivery.io/v1/organizations/{organizationSlug}/stores/{storeId}/otp-users 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationSlug}/stores/{storeId}/otp-users" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationSlug}/stores/{storeId}/otp-users", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationSlug}/stores/{storeId}/otp-users",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

storeId string
required
Match pattern: ^[a-fA-F0-9]{24}$

page integer
optional
Page number for paginated results, starting from one, controlling which subset of records is returned.
limit integer
optional
Maximum number of OTP user records to return per page, controlling the response payload size.
sort string
optional
Sorting criteria for the results expressed as a field and direction pair separated by a colon.
Match pattern: ^[\w.]*((:asc)|(:desc))?$
publishedApplicationId string
optional
Identifier of the published application associated with this OTP user, restricting download permissions to a single app.
Match pattern: ^[a-fA-F0-9]{24}$
applicationId string
optional
Identifier of the parent application used to filter OTP users across all published applications belonging to that app.
Match pattern: ^[a-fA-F0-9]{24}$
email string
optional
Partial or full email address used to filter OTP users by matching against their registered email.
≤ 500 characters
allowedDownloadsNum any
optional
Filter by exact download allowance using an integer (for example -1 for unlimited, 0, 1), or by threshold using the format ">N" (for example ">0", ">1", ">2").

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Unique identifier for the OTP user record used to reference and manage the user across all store operations.
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string required
Identifier of the organization that owns this OTP user, establishing the top-level resource isolation boundary.
Match pattern: ^[a-fA-F0-9]{24}$
storeId string required
Identifier of the store to which this OTP user belongs, scoping download access to a specific distribution channel.
Match pattern: ^[a-fA-F0-9]{24}$
publishedApplicationId string required
Identifier of the published application associated with this OTP user, restricting download permissions to a single app.
Match pattern: ^[a-fA-F0-9]{24}$
email string required
Email address of the OTP user serving as the primary identity for authentication and one-time password delivery.
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
allowedDownloadsNum integer required
Maximum number of downloads permitted for this OTP user where minus one indicates unlimited access.
≥ -9007199254740991 · ≤ 9007199254740991
lastLoginDate string required
Timestamp of the most recent OTP authentication event recorded for this user, nullable when no login has occurred.
lastDownloadDate string required
Timestamp of the most recent application download performed by this user, nullable when no download has occurred.
createdAt string required
Timestamp indicating when the OTP user record was initially created in the system for audit and tracking purposes.
updatedAt string required
Timestamp indicating when the OTP user record was last modified, reflecting the most recent configuration change.
totalDocs integer required
≥ -9007199254740991 · ≤ 9007199254740991
limit integer required
≥ -9007199254740991 · ≤ 9007199254740991
hasPrevPage boolean required
hasNextPage boolean required
page integer required
≥ -9007199254740991 · ≤ 9007199254740991
totalPages integer required
≥ -9007199254740991 · ≤ 9007199254740991
prevPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
nextPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organizationId": "string",
                "storeId": "string",
                "publishedApplicationId": "string",
                "email": "[email protected]",
                "allowedDownloadsNum": 0,
                "lastLoginDate": "string",
                "lastDownloadDate": "string",
                "createdAt": "string",
                "updatedAt": "string"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}