Get User

Lookup a user by their email or userId. One of either the email or userId is required to complete the request.

Parameters

name	type	data type	description
userId	optional	string	Lookup a user by their userId. Either userId or email must be set
email	optional	string	Lookup a user by their email. Either userId or email must be set

Return Value

The returned value of a successful request will include a message describing the result and a data field with the requested user.

json

{
  "message": "user retrieval completed",
  "data": { ... },
}

Examples

bash

curl -X GET -H "Authentication: ZmFrZQ==" https://app.wombat.software/api/{targetPath}/user?email=tester%40example.ca