Admin

List Users

List active users in the authenticated admin's organization with page-based pagination


GET /user-admin-v1

Requires the authenticated user to be an organization admin (organization_admin = true) or a site admin (is_admin = true). Results are automatically scoped to the authenticated user's organization.

ParameterTypeDataTypeDescription
pagequeryintegerPage number (default: 1)
page_sizequeryintegerNumber of items per page (default: 50, max: 200)

NOTE

  • Only users with status = active are returned.
  • Results are scoped to the authenticated user's organization_id.
  • Results are ordered by user_id ascending.

Request

https://premium.aiera.com/api/user-admin-v1?page=1&page_size=50

Response

{
  "pagination": {
    "total_count": 25,
    "current_page": 1,
    "total_pages": 1,
    "page_size": 25
  },
  "data": [
    {
      "user_id": 12345,
      "username": "jsmith",
      "first_name": "Jane",
      "last_name": "Smith",
      "primary_email": "jane.smith@example.com",
      "api_key": "abc123def456",
      "is_active": true,
      "status": "active",
      "create_date": "2023-06-15T14:30:00",
      "last_active": "2024-11-01T09:15:00"
    }
  ]
}

Error Responses

Status CodeDescription
401Missing or invalid authentication
403User is not an organization admin or site admin

Code Samples

Bash

curl --request GET \
  --url 'https://premium.aiera.com/api/user-admin-v1?page=1&page_size=50' \
  --header 'X-API-Key: xxx'

Python

import requests
requests.get(
    "https://premium.aiera.com/api/user-admin-v1",
    params={"page": 1, "page_size": 50},
    headers={"X-API-Key": "xxx"}
)
Previous
EventList