INinfomaniak
User Management > Accounts

List users

Changed on

This endpoint allows you to retrieve all users of a single Account specified by the requested unique identifier.

get/2/accounts/{account}/users

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/2/accounts/{account}/users
  • Auth
    HTTP bearer

Path parameters

accountinteger required

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

drive_idinteger
has_billing_accessboolean
has_empty_accessboolean
has_kchatboolean
has_ksuiteboolean
has_no_app_accessboolean
has_otpboolean
invitation_statusstring
mail_idsinteger[]
not_in_team_idsinteger[]
role_typestring
state_in_account'pending' | 'valid'
team_idsinteger[]
user_idsinteger[]
unknown
unknown
searchstring
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

string
OR
string[]

Optional parameter that define the field used for sorting<br /> Part of the sort capacity

order'asc' | 'desc'

Optional parameter that define the default sort order<br /> Part of the sort capacity

order_forobject

Optional parameter that define the sorting order for a field<br /> By default order is used<br /> Part of the sort capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes

  • 96ca7c8a0545Revision changes
    • warning

      deleted the query request parameter order_by

    • warning

      deleted the query request parameter order_for

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter order_for

  • 0cd8a60951f5Revision changes
    • warning

      deleted the query request parameter order_by

    • warning

      deleted the query request parameter order_for

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter order_for