Get account users

GET 
/v1/accounts/:account_id/users

Get account users

This endpoint retrieves a paginated list of users associated with a specific account, including details such as user ID, nickname, email, role, and whether they are an approver. It supports filtering by creation dates and sorting by various fields. Access control checks ensure that the requesting user has permission to view the account's users.

Request

Path Parameters

account_id uuidrequired

Account id

Query Parameters

order_by string

Order by

page int32

Page

page_size int32

Page size

sort_by string

Sort by

order_by string

Order by

end_date date-time

End date

start_date date-time

Start date

Responses

200

Ok

application/json

Schema

Schema

• Array [
approver booleanrequired
email stringnullable
hpkePubKey binarynullable
id uuidnullable
invited booleanrequired
isOwner booleanrequired
nickname stringnullable
role objectnullable
id uuidrequired
name stringrequired
status stringnullable
userExists booleanrequired
• ]

Example (from schema)

[
  {
    "approver": true,
    "email": "string",
    "hpkePubKey": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "invited": true,
    "isOwner": true,
    "nickname": "string",
    "role": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "status": "string",
    "userExists": true
  }
]

403

Don't have access to account

application/json

Schema

Schema

string

Loading...