List users for a site

curl --request GET \
  --url https://api.altostrat.io/sites/{siteId}/users \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 12345,
      "name": "Jane Doe",
      "email": "[email protected]",
      "avatar": "https://example.com/avatar.jpg",
      "ip_address": "192.168.88.150",
      "mac_address": "00:1A:2B:3C:4D:5E",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36...",
      "session_ends_at": "2025-10-29T23:59:59Z",
      "created_at": "2025-10-29T11:59:59Z",
      "is_active": true
    }
  ],
  "links": {},
  "meta": {}
}

GET

sites

{siteId}

users

List users for a site

curl --request GET \
  --url https://api.altostrat.io/sites/{siteId}/users \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 12345,
      "name": "Jane Doe",
      "email": "[email protected]",
      "avatar": "https://example.com/avatar.jpg",
      "ip_address": "192.168.88.150",
      "mac_address": "00:1A:2B:3C:4D:5E",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36...",
      "session_ends_at": "2025-10-29T23:59:59Z",
      "created_at": "2025-10-29T11:59:59Z",
      "is_active": true
    }
  ],
  "links": {},
  "meta": {}
}

Authorizations

Authorization

string

header

required

API Key authentication. Provide your token in the 'Authorization' header. Example: Authorization: Bearer <YOUR_TOKEN>

Path Parameters

siteId

string<uuid>

required

The unique identifier for the site.

Example:

"a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6"

Query Parameters

string

A search term to filter users by name, email, or MAC address.

mac

string

Filter users by a specific MAC address.

active

boolean

Set to true to return only users with an active session.

per_page

integer

default:15

The number of users to return per page.

Response

A paginated list of users.

data

object[]

Show child attributes

data.id

integer

The unique identifier for the user session.

Example:

12345

data.name

string

The name of the user, as provided by the identity provider or coupon.

Example:

"Jane Doe"

data.email

string<email>

The email address of the user.

Example:

"[email protected]"

data.avatar

string<uri> | null

A URL to the user's avatar image.

Example:

"https://example.com/avatar.jpg"

data.ip_address

string<ipv4>

The internal IP address of the user's device.

Example:

"192.168.88.150"

data.mac_address

string | null

The MAC address of the user's device.

Example:

"00:1A:2B:3C:4D:5E"

data.user_agent

string | null

The user agent string of the user's browser.

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36..."

data.session_ends_at

string<date-time>

The timestamp when the user's session will expire.

Example:

"2025-10-29T23:59:59Z"

data.created_at

string<date-time>

The timestamp when the user first authenticated.

Example:

"2025-10-29T11:59:59Z"

data.is_active

boolean

A boolean indicating if the user's session is currently active.

Example:

true

links

object

Getting Started

Platform & Identity

Device Management & Orchestration

Automation & AI

Network Services & Connectivity

Security & Threat Management

Monitoring & Analytics

Core Services & Utilities

List users for a site

Authorizations

Path Parameters

Query Parameters

Response