Skip to main content
GET
/
v1
/
regions
/
global
/
iam
/
users
List users
const options = {method: 'GET'};

fetch('https://api.example.com/v1/regions/global/iam/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "emailVerified": true,
      "status": "active",
      "name": "<string>",
      "image": "<string>",
      "mfaEnabled": true,
      "lastLoginAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Query Parameters

status
enum<string>

Filter by status

Available options:
active,
suspended,
deactivated

Search by name or email

limit
number
default:20

Maximum results

offset
number
default:0

Results to skip

Response

200 - application/json

List of users

success
enum<boolean>
Available options:
true
data
object[]
meta
object