4b3471151a8b

latestOpenAPI 3.1.02026-08-1084336455.2 KB
Users

List Users

Authorization scope: user:list

List users

get/v1/accounts/{account_id}/users

Path parameters

account_idstring required

Query parameters

emailstring nullable

Query parameter for filtering by email

Query parameter for filtering by email

namestring nullable

Query parameter for filtering name in email or user name

Query parameter for filtering name in email or user name

team_idstring[] nullable

Query parameter for filtering by team id

Query parameter for filtering by team id

pageinteger
items_per_pageinteger
sort_by'user_name' | 'created_at' | 'last_login' | 'user_email' | 'invited_by' | 'is_admin' | 'source'

User sort properties in the UI.

sort_order'desc' | 'asc'

Sorting can be either asc or desc, used in the api-service

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

pageinteger

The page number

current_page_sizeinteger required

The current page size

total_itemsinteger

The total number of entities fetched

account_idstring required

The account id

Example response

{
  "items": [
    {
      "user_id": "5f887c764c40e5598f717676",
      "user_email": "user@rivey.io",
      "user_name": "John Doe",
      "environments": {
        "5f887c764c40e5598f717676": {
          "role": "admin"
        }
      },
      "is_admin": true,
      "status": "active",
      "created_at": "2026-08-10T14:41:14.529768",
      "last_login": "2026-08-10T14:41:14.529768",
      "updated_at": "2026-08-10T14:41:14.529768",
      "groups": [
        "5f887c764c40e5598f717676"
      ],
      "source": "rivery",
      "invited_by": "invite@rivey.io",
      "onboarding": {
        "know_rivery_step": {
          "onboarding_river_types": {
            "status": true,
            "update_time": "2026-08-10T14:41:14.529768"
          },
          "onboarding_rivery_introduction": {
            "status": true,
            "update_time": "2026-08-10T14:41:14.529768"
          }
        },
        "data_connections_step": {
          "onboarding_add_connection": false
        },
        "data_pipeline_step": {
          "onboarding_create_s2t": false,
          "onboarding_view_activities": false
        }
      }
    }
  ]
}