userManagement

List user accounts

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

User + List

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info>

Retrieves the collection of user accounts, filtered, sorted and paged accourding to query parameters.

get/api/v1/user

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/user
  • Auth: HTTP bearer

Query parameters

pagenumber double

Current page number

qstring

Filter parameter in <filter>:<value> format. Multiple filters must be in the format of a comma separated list of the following fields:

  • id
  • status
  • name
  • username
  • organisation
per_pageinteger

Defines the number of items per page

sortstring

Sort parameter in <operator><field> format. Expects a comma-separated list from the allowed fields:

  • id
  • status
  • name
  • username
  • organisation
  • created

Response

Successfully returned a list of Users

idinteger
usernamestring
namestring
createdstring

Changes

No recorded changes to this operation across all 1 revision of this API.