List users

GET

/api/nova/users/list

Returns all users on the account that are visible to the authenticated API user, in a single unpaginated list. Each item contains the user's id, firstName, lastName, email, mobile, role, jobTitle and active flag. The only required parameter is the apiKey. Returns 401 if the API key is invalid.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Query Parameters

apiKey*

apiKey

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"active": true,

  

  

  

"email": "string",

  

  

  

"firstName": "string",

  

  

  

"id": "string",

  

  

  

"jobTitle": "string",

  

  

  

"lastName": "string",

  

  

  

"mobile": "string",

  

  

  

"role": "string"

  

  

}

  

],

  

"error": "string",

  

"message": "string",

  

"page": 0,

  

"requestId": "string",

  

"size": 0,

  

"success": true,

  

"total": 0

}

GET

/api/nova/users/list

Playground

Authorization

privateApiKey

Variables

Key

Value

apiKey*

Samples