Users API

_{Organization & Account Management}

Get the currently logged-in user

Retrieves the currently authenticated user's profile data. This is a GET operation. The JSON response contains user attributes such as email, name, role, and default account.

get{hostname}/users

Create a new user

Creates a new user profile. This is a POST operation that accepts a JSON body and returns the created user object in JSON format.

post{hostname}/users

Body:

{
  "country_id": "CA # Type: string",
  "email": "daniel@sajmx.com # Type: string",
  "first_name": "Jamie # Type: string",
  "last_name": "Jackson # Type: string",
  "other_id": "sdh23yv3bobe6yob82 # Type: string"
}

API Request Parameters

Name	Type	Required Field	Description
country_id	string	False	User Country code. Reference: https://gist.github.com/keeguon/2310008)
email	string	False	User email address
first_name	string	False	User first name
last_name	string	False	User last name
other_id	string	False	This can represent the ID of an external system linked to the user

Update current user

Updates the current user's profile information. This is a PUT operation that accepts a JSON body and returns the updated user object.

put{hostname}/users

Body:

{
  "country_id": "CA # Type: string",
  "email": "smith@cool.com # Type: string",
  "first_name": "Smith # Type: string",
  "last_name": "Pierre # Type: string",
  "other_id": "12a3x34 # Type: string"
}

API Request Parameters

Name	Type	Required Field	Description
country_id	string	True	Country
email	string	True	User email
first_name	string	True	User first name
last_name	string	False	User last name
other_id	string	False	This can represent the ID of an external system linked to the user

Delete current user

Deletes the currently authenticated user's profile. This is a DELETE operation. Returns HTTP 200 or 204 if the profile was removed.

delete{hostname}/users

Update current user's default account

Updates the default account associated with the currently authenticated user. This is a PUT operation that accepts a JSON object specifying the new default account ID.

put{hostname}/users/defaultaccount

Body:

{
  "organization_id": "113 # Type: integer"
}

API Request Parameters

Name	Type	Required Field	Description
organization_id	integer	True	The numeric ID of the of the account

Find user's by their registration emails

Searches for a user by their registered email address. This is a GET operation. The JSON response containing the user's profile data if found.

get{hostname}/users/search_by_email/{email}

API Request Parameters

Name	Type	Required Field	Description
email	string	True	The registered email address of the user to look up. Type: string. Must be included in the URL path. Required.