Users

To get more detailed information about some the contents of the requested/returned representation of resources related to users, see also User and the Identity classes.

GET

GET /api/users

Get registered users.

GET /api/users/(identity_type)/(username)

Get the user specified by the given identity_type and username.

GET /api/users/(int:id)

Get the user specified by the given id.

GET /api/users/(int:id)/collections

Get created or shared collections of the user specified by the given id.

GET /api/users/(int:id)/groups

Get created or common groups of the user specified by the given id.

GET /api/users/(int:id)/identities

Get all identities of the user specified by the given id.

GET /api/users/(int:id)/records

Get created or shared records of the user specified by the given id.

GET /api/users/(int:id)/templates

Get created or shared templates of the user specified by the given id.

GET /api/users/me

Get the current user.

GET /api/users

Get registered users.

Versions: v1 (latest)

Required scopes: user.read

Query parameters

  • page - The current result page. (Default: 1)

  • per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

  • filter - A query to filter the users by their display name or username.

  • inactive - Flag indicating whether inactive users should be returned as well. (Default: False)

  • sysadmins - Flag indicating whether only users marked as sysadmin should be returned. Only usable by sysadmins. (Default: False)

Status codes

  • 200 (OK) - Return a paginated array of users, sorted by creation date in descending order.

GET /api/users/(identity_type)/(username)

Get the user specified by the given identity_type and username.

Versions: v1 (latest)

Required scopes: user.read

Status codes

  • 200 (OK) - Return the user.

GET /api/users/(int: id)

Get the user specified by the given id.

Versions: v1 (latest)

Required scopes: user.read

Status codes

  • 200 (OK) - Return the user.

GET /api/users/(int: id)/collections

Get created or shared collections of the user specified by the given id.

Shared means that the user needs to have at least explicit read permission for a collection.

Versions: v1 (latest)

Required scopes: user.read and collection.read

Query parameters

  • page - The current result page. (Default: 1)

  • per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

  • filter - A query to filter the collections by their title or identifier.

  • sort - The order of the returned collections. One of last_modified, -last_modified, created_at, -created_at, title, -title, identifier or -identifier. (Default: -last_modified)

  • shared - Flag indicating whether collections the user created should be returned or collections created by the current user that were explicitly shared with the user. (Default: False)

Status codes

  • 200 (OK) - Return a paginated array of collections.

GET /api/users/(int: id)/groups

Get created or common groups of the user specified by the given id.

Common means that both the current and the specified user need to be a member of a group.

Versions: v1 (latest)

Required scopes: user.read and group.read

Query parameters

  • page - The current result page. (Default: 1)

  • per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

  • filter - A query to filter the groups by their title or identifier.

  • sort - The order of the returned groups. One of last_modified, -last_modified, created_at, -created_at, title, -title, identifier or -identifier. (Default: -last_modified)

  • common - Flag indicating whether groups the user created should be returned or groups that the current user and the specified user have in common regarding group membership. (Default: False)

Status codes

  • 200 (OK) - Return a paginated array of groups.

GET /api/users/(int: id)/identities

Get all identities of the user specified by the given id.

Versions: v1 (latest)

Required scopes: user.read

Status codes

  • 200 (OK) - Return an array of identities, sorted by creation date in ascending order.

GET /api/users/(int: id)/records

Get created or shared records of the user specified by the given id.

Shared means that the user needs to have at least explicit read permission for a record.

Versions: v1 (latest)

Required scopes: user.read and record.read

Query parameters

  • page - The current result page. (Default: 1)

  • per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

  • filter - A query to filter the records by their title or identifier.

  • sort - The order of the returned records. One of last_modified, -last_modified, created_at, -created_at, title, -title, identifier or -identifier. (Default: -last_modified)

  • shared - Flag indicating whether records the user created should be returned or records created by the current user that were explicitly shared with the user. (Default: False)

Status codes

  • 200 (OK) - Return a paginated array of records.

GET /api/users/(int: id)/templates

Get created or shared templates of the user specified by the given id.

Shared means that the user needs to have at least read permission for a template.

Versions: v1 (latest)

Required scopes: user.read and template.read

Query parameters

  • page - The current result page. (Default: 1)

  • per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

  • filter - A query to filter the templates by their title or identifier.

  • sort - The order of the returned templates. One of last_modified, -last_modified, created_at, -created_at, title, -title, identifier or -identifier. (Default: -last_modified)

  • shared - Flag indicating whether templates the user created should be returned or templates created by the current user that were explicitly shared with the user. (Default: False)

Status codes

  • 200 (OK) - Return a paginated array of templates.

GET /api/users/me

Get the current user.

Versions: v1 (latest)

Required scopes: user.read

Status codes

  • 200 (OK) - Return the current user.