List all mPass users
GET/api/gateway/v1/mpass/users
List all mPass users
Request
Query Parameters
Search by name or email
Possible values: [active, inactive]
Filter by user status
Possible values: <= 50
Default value: 25
Number of items per page
Default value: 1
Page number
Default value: DESC
Order of the items
Key of the items
Header Parameters
Gateway API key
Responses
- 200
- 401
List of mPass users
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Response status code
Response status message
data
object[]
required
Response data
User ID
User name
User email
Membership ID
Possible values: [active, inactive]
User status
User tier code
Created date
Disabled date
Request ID for tracking
meta
object
Pagination details, if applicable
Current page number
Number of items per page
Number of returned items
Total number of items
Total number of pages
Has next page
Has previous page
{
"status": 200,
"message": "OK",
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"email": "john.doe@example.com",
"membershipId": "memb-550e8400-e29b-41d4-a716-446655440000",
"status": "active",
"tierCode": "STANDARD",
"createdAt": "2023-01-01T00:00:00.000Z",
"disabledAt": "2023-01-01T00:00:00.000Z"
}
],
"requestId": "req-123456",
"meta": {
"page": 1,
"perPage": 10,
"count": 10,
"totalCount": 100,
"totalPages": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
error
object
Error code
Error detail
{
"status": 401,
"message": "Invalid API key",
"error": {
"code": "UNAUTHORIZED",
"detail": "Invalid API key"
}
}