List members | Alephant API Documentation

curl https:https://localhost:8080/api/v1/members \
     -H "Authorization: Authorization" \
     -H "X-Workspace-Id: X-Workspace-Id"

{
  "data": [
    {
      "createdAt": "string",
      "departmentId": "string",
      "email": "string",
      "id": "string",
      "keyExpiresAt": "string",
      "keyExpiryPreset": "string",
      "masterKeyId": "string",
      "monthlyBudget": 1.1,
      "name": "string",
      "note": "string",
      "requests": 1,
      "roleLabel": "string",
      "spend": 1.1,
      "status": "string",
      "tokens": 1,
      "virtualKey": "string",
      "virtualKeyId": "string",
      "virtualKeyStatus": "string"
    }
  ],
  "meta": {
    "overview": {
      "activeCount": 1,
      "totalMonthlyBudgetCents": 1,
      "totalPeriodRequests": 1,
      "totalPeriodSpendCents": 1,
      "totalPeriodSpendUsd": 1.1,
      "totalPeriodTokens": 1,
      "withVirtualKeyCount": 1
    },
    "page": 1,
    "pageSize": 1,
    "total": 1,
    "totalPages": 1
  }
}

List members with usage from v_member_usage. Owner, admin, viewer. Member role cannot list. When Collector analytics is configured, spend and requests on each row and overview totals are merged from GET /v1/analytics/members/cost-breakdown (default Collector window, no date query params) by member id.

Query parameters

pageintegerOptionalDefaults to 1

Page number

pageSizeintegerOptionalDefaults to 20

Items per page

statusstringOptional

active, revoked, suspended

departmentIdstringOptional

Department UUID

searchstringOptional

Search name/email

Response

datalist of objects

metaobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Headers

Query parameters

Response

Errors