API Reference
Eratos Workspace

Get a collection of users.

get
https://senaps.eratos.com/api/sensor/v2/users

This request will return a collection of all users known to the Sensor Data API. Only Organisation or Admin roles with the read user permission will be authorised.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Only return users with this id or partial match using wildcards (*, ?).

  • matches zero or more characters.
  • ? matches exactly one character.

For example, bo* will match any word starting with bo, such as bo, bom, body, and so on. On the other hand, bo? will only match three-letter words starting with bo, such as bo, bom, and so on.

string

A comma separated list of roleids to filter the returned roles.

string

When true, only hidden users will be returned in the search results. When false (default), only visible users will be returned.

number

Maximum number of users to return

number

Skip this many results.

boolean

Return full details of users

boolean

Return full details of roles

Responses

Updated 12 months ago

Did this page help you?
Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago

Did this page help you?