Skip to main content
GET
/
v1
/
organizations
/
users
{
  "users": [
    {
      "user_id": "<string>",
      "email": "<string>",
      "email_confirmed": true,
      "locked": true,
      "enabled": true,
      "has_password": true,
      "update_password_required": true,
      "mfa_enabled": true,
      "can_create_orgs": true,
      "created_at": 123,
      "last_active_at": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "username": "<string>",
      "picture_url": "<string>",
      "properties": {},
      "user_role": "<string>",
      "user_permissions": [
        "<string>"
      ],
      "additional_roles": [
        "<string>"
      ],
      "inherited_user_roles_plus_current_role": [
        "<string>"
      ],
      "org_metadata": {
        "is_test": true,
        "env": "<string>",
        "organization_id": "<string>"
      },
      "legacy_user_id": "<string>",
      "notifications_enabled": true
    }
  ],
  "total_users": 123,
  "current_page": 123,
  "page_size": 123,
  "has_more_results": true
}

Authorizations

​
X-API-KEY
string
header
required

Headers

Query Parameters

​
page_size
integer
default:20
​
page_number
integer
default:0
​
include_orgs
boolean | null
​
role
string | null
​
force_refresh_notifications
boolean
default:false

Force refresh notification settings from PropelAuth to get the most current data. Use this immediately after updating user notification preferences.

Response

Successful Response

​
users
UserResponse · object[]
required
​
total_users
integer | null
required
​
current_page
integer | null
required
​
page_size
integer | null
required
​
has_more_results
boolean | null
required