Skip to content

Users

Account Scope Required, please include X-Auth-Account header with your Account ID.

List Users

List all users associated with your account.

GET /api/users

Returned Params
  • users: Array
    • fname: String
    • lname: String
    • email: String
    • created_at: DateTime
    • updated_at: DateTime

View User

View a user

GET /api/users/:id

Returned Params
  • user: Object
    • fname: String
    • lname: String
    • email: String
    • created_at: DateTime
    • updated_at: DateTime

Create a User

POST /api/users

This will create a user (and new account) as a sub-user/account on the current account.

Params
  • user: Object
    • fname: String (required)
    • lname: String (required)
    • email: String (required)
    • company_name: String | This will be the account name.
    • billing_term: String | monthly,annual
    • set_reseller_billing_plan_id: Integer
Returned Params
  • user: Object
    • id: String
    • fname: String
    • lname: String
    • email: String
    • password: String
    • account_id: String
    • api_token: String