Skip to main content
GET
Who can do what, and how widely. reaches_every_site is true when a user has no site grants, personal or through a role (role-based data access) — the sites list is the union of both, deduplicated.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
email
string
username
string
sign_in_handle
string
name
string
phone
string
status
string
is_service_account
string
last_login_at
string
roles
string
effective_permissions
string
has_no_roles
string
reaches_every_site
string
sites
string
linked_organizations
string
invitation_sent_at
string
invitation_expires_at
string
invitation_sends
string
invitation_is_live
string
worker_id
string
worker_number
string
worker_name
string
worker_type
string
worker_is_active
string
worker_teams
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

effective_permissions
integer<bigint>
email
string<public.citext>
has_no_roles
boolean<boolean>
id
string<uuid>

Note: This is a Primary Key.

invitation_expires_at
string<timestamp with time zone>
invitation_is_live
boolean<boolean>
invitation_sends
integer<integer>
invitation_sent_at
string<timestamp with time zone>
is_service_account
boolean<boolean>
last_login_at
string<timestamp with time zone>
linked_organizations
integer<integer>
name
string<character varying>
Maximum string length: 200
phone
string<character varying>
Maximum string length: 40
reaches_every_site
boolean<boolean>
roles
string<jsonb>
row_version
integer<bigint>
sign_in_handle
string<text>
sites
string<jsonb>
status
string<character varying>
Maximum string length: 30
username
string<public.citext>
worker_id
string<uuid>

Note: This is a Primary Key.

worker_is_active
boolean<boolean>
worker_name
string<character varying>
Maximum string length: 200
worker_number
string<character varying>
Maximum string length: 60
worker_teams
string<jsonb>
worker_type
string<character varying>
Maximum string length: 150