Skip to main content
GET
/
admin
/
users
List all system users
curl --request GET \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/admin/users \
  --header 'Authorization: <api-key>'
{
  "total_count": 123,
  "users": [
    {
      "account_id": "<string>",
      "agent_id": "<string>",
      "created_at": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "id": "<string>",
      "last_login_at": "<string>",
      "last_name": "<string>",
      "name": "<string>",
      "pep_access_authorized": true,
      "phone_number": "<string>",
      "role": "<string>",
      "status": "<string>",
      "user_type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Query Parameters

role
string

Filter by role

status
string

Filter by status

Response

OK

total_count
integer
users
object[]