Get user by ID

GET

/api/nova/users/{userId}

Fetches a single user by the userId path parameter, scoped to the authenticated API user's account. The response contains the user's id, firstName, lastName, email, mobile, role, jobTitle and active flag. Returns 404 if no matching user is found, and 401 if the API key is invalid.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

userId*

userId

Type

string

Required

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",

  

"requestId": "string",

  

"success": true

}

GET

/api/nova/users/{userId}

Playground

Authorization

privateApiKey

Variables

Key

Value

userId*

apiKey*

Samples