Sign in
latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
clients

Get Users By Client

Get all users for a client

get/api/v1/admin/clients/{client_id}/users

Path parameters

client_idstring required

Query parameters

active_onlyboolean
include_deletedboolean

Response

Successful Response

emailstring required
first_namestring required
last_namestring required
transaction_limitnumber nullable
allocated_amountnumber nullable
idstring uuid4 required
okta_user_idstring required
client_idstring uuid4 required
extra_profile_dataobject nullable
is_activeboolean required
billing_ownerboolean required
plan_tierstring
current_consumptionnumber nullable
mcp_daily_limitnumber nullable
role_idstring uuid4 nullable
role_namestring nullable
block_role'block_user' | 'block_admin'

Additive Block role values stored directly on users.block_role and groups.block_role (block_role_enum Postgres enum). Matches the snake_case value set used elsewhere in the Block domain.

distributor_role'Distributor Admin' | 'Distributor User'

Additive distributor role stored directly on users.distributor_role (distributor_role_enum Postgres enum), the same pattern as block_role. DISTRIBUTOR_ADMIN grants access to the platform's distributor features, scoped by the user's client's distributor contract(s); DISTRIBUTOR_USER marks a non-administrative distributor user and grants no distributor-view access on its own.

prompt_accessboolean
group_idstring uuid4 nullable
group_namestring nullable
group_mcp_period_limitnumber nullable
client_namestring nullable
statusstring nullable
data_collection_consent'granted' | 'not-granted' nullable
deleted_atstring date-time nullable
deletion_reasonstring nullable