INinfomaniak
Drive

Get users

Changed on

Retrieves a list of users. By default, this endpoint returns all active account users. Using the types parameter, you can filter by: account, drive role, or pending invitation.

<br><note>The results are filtered based on the requesting user's permissions.</note>

get/3/drive/{drive_id}/users

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/3/drive/{drive_id}/users
  • Auth
    HTTP bearer

Path parameters

drive_idinteger required

Drive identifier

Query parameters

withstring

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

cursorstring

The cursor parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

limitinteger

The maximum number of items returned

order_bystring[]
order'asc' | 'desc'

Specifies the default sorting direction for any order_by parameters provided

order_forstring[]
searchstring

Search user by his first name, last name or email

statusstring[]

Status of the resource {name}

typesstring[]
user_idsinteger[]

User identifiers

Response

OK

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

Result of the HTTP request

cursorstring nullable required

Cursor pagination uses a cursor to track the current position in the dataset. This cursor should be passed back in the subsequent API request in order to retrieve the next set of results or page of the list.

has_moreboolean required

The has_more boolean flag indicates whether additional items are available beyond the current page of results.

response_atinteger required

The timestamp, in seconds, indicating when the dataset was generated.

Changes

  • 78c48609ff48Revision changes
    • info

      added the required property /////// to the response with the status