v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Users

Create User

Create a user along with their company profile.

post/v1/user/

Request body

firstNamestring nullable required

The given name of a user.

lastNamestring nullable required

The family name of a user.

emailstring required

The email of address of the user, the email should be unique.

phonestring nullable required

The default phone number of the user.

phoneCellstring nullable required

The mobile phone number of the user.

phoneWorkstring nullable required

The work, or office phone number of the user.

addressstring nullable required

The address lines of the user.

citystring nullable required

The city or municipality of the user.

postalCodestring nullable required

The postal code, or zip code of the user.

countrystring nullable required

The country of the user.

timezonestring nullable required

The timezone of the user.

birthDatestring date-time nullable required

The user's date of birth.

industryIdinteger nullable required

The industry identifier associated with this user.z

tradeIdinteger nullable required

The primary trade associated with this user.

emergencyContactstring nullable required

The name of the emergency contact.

emergencyContactPhonestring nullable required

The phone number of the emergency contact

passwordstring required

The password for the user.

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "j.doe@example.com",
  "phone": "6045551234",
  "phoneCell": "6045551234",
  "phoneWork": "6045554321",
  "address": "#22 - 321 Someplace St",
  "city": "Burnaby",
  "postalCode": "V3V2X2",
  "country": "Canada",
  "timezone": "America/Vancouver",
  "birthDate": "1980-01-23",
  "industryId": 1,
  "tradeId": 12,
  "emergencyContact": "John Smith",
  "emergencyContactPhone": "6045551234",
  "password": "Some_Secure_Password_0012@#",
  "companyUser": {
    "isActive": true,
    "editTimer": true,
    "createTimer": true,
    "position": "Office Manager",
    "employeeId": "EM00123",
    "roleId": 4
  }
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "j.doe@example.com",
    "phone": "6045551234",
    "phoneCell": "6045551234",
    "phoneWork": "6045554321",
    "address": "#22 - 321 Someplace St",
    "city": "Burnaby",
    "postalCode": "V3V2X2",
    "country": "Canada",
    "timezone": "America/Vancouver",
    "birthDate": "1980-01-23",
    "industryId": 1,
    "tradeId": 12,
    "emergencyContact": "John Smith",
    "emergencyContactPhone": "6045551234",
    "companyUser": {
      "id": 1275,
      "role": {
        "id": 4,
        "name": "Foreman",
        "slug": "foreman"
      },
      "isActive": true,
      "employeeId": "EM00123",
      "position": "Office Manager",
      "editTimer": true,
      "createTimer": true,
      "userId": 2,
      "companyId": 1
    }
  }
}