List User Accounts | emnify Documentation

curl -G https://cdn.emnify.net/api/v1/user \
     -H "Authorization: Bearer <token>" \
     -d q= \
     -d sort=

[
  {
    "id": 20,
    "username": "franz@example-tracking-org.com",
    "name": "Franz Liszt",
    "created": "2019-08-31T16:47:00.000Z",
    "status": {
      "id": 1,
      "description": "Active"
    },
    "organisation": {
      "id": 123,
      "name": "Fleet Tracking Org"
    }
  },
  {
    "id": 1,
    "username": "user@example-iot-org.com",
    "name": "Douglas Adams",
    "created": "2019-10-12T08:00:00.000Z",
    "status": {
      "id": 2,
      "description": "Suspended"
    },
    "organisation": {
      "id": 10,
      "name": "Example IoT Org"
    }
  },
  {
    "id": 2,
    "username": "admin@example-iot-org.com",
    "name": "Edwin Abbott",
    "created": "2019-08-31T16:47:00.000Z",
    "status": {
      "id": 1,
      "description": "Active"
    },
    "organisation": {
      "id": 10,
      "name": "Example IoT Org"
    }
  }
]

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

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Query parameters

pagedoubleOptional

Current page number

qstringOptionalformat: "(id|status|name|username|organisation)\:.+"

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

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_pageintegerOptional

Defines the number of items per page

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

id
status
name
username
organisation
created

Sort parameter in `<operator><field>` format. Expects a comma-separated list from the allowed fields: * `id` * `status` * `name` * `username` * `organisation` * `created`

Response headers

Linkstring or null

URLs for navigational links used to retrieve first, previous, next and last page in a dataset

X-Count-Per-Pageinteger

The requested per_page parameter

X-Current-Pageinteger

The current page number within the current data set

X-Total-Countinteger

The total element count in the current data set

X-Total-Pagesinteger

The total page count in the current data set

X-Filterstring or null

If filtering is applied using ?q=field:criteria URL query parameters, the filter criteria is returned here

X-Sortstring or null

If sorting is applied using ?sort=sort_criteria URL query parameters, the sort criteria is returned here

Response

Successfully returned a list of Users

idinteger or null

usernamestring or null

namestring or null

createdstring or null

statusobject or null

organisationobject or null