Upcoming breaking changes in user endpoints

On or after Jan 29, 2025, we will be updating Users endpoints with changes to how company-specific user information is returned. This will clarify the distinction between information about a user and information related to a user at a company.

We recommend you update your code ahead of the change to send and accept either format. Our API ignores any unexpected fields, so both the old and new format can be provided simultaneously without errors. Sending information in the old format will not cause an error, but will not be saved. Specifying companyUser and all the fields inside it will be required and cause an error if not provided.

Change Details

In endpoints that accept or return both user and company-specific user information, all fields for company-specific user information will be moved to a nested object with the key companyUser.

The Search Users and Get Project Workers endpoints will be updated to return:

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "updatedAt": "2025-01-16T18:54:22.920Z",
  "createdAt": "2025-01-16T18:54:22.920Z",
  "companyUser": {
    "role": {
      "id": 4,
      "name": "Foreman",
      "slug": "foreman"
    },
    "isActive": true,
    "employeeId": "EM00123"
  }
}

The Create User, Get User Details and Update Role endpoints will be updated to return:

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "updatedAt": "2025-01-16T23:15:22.799Z",
  "createdAt": "2025-01-16T23:15:22.799Z",
  "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": {
    "role": {
      "id": 4,
      "name": "Foreman",
      "slug": "foreman"
    },
    "isActive": true,
    "employeeId": "EM00123",
    "editTimer": true,
    "createTimer": true,
    "documentAccess": "read",
    "feedAccess": "read",
    "position": "Office Manager",
    "userId": 2,
    "companyId": 1
  }
}

The Create User endpoint will be updated to accept:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "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,
    "documentAccess": "read",
    "feedAccess": "read",
    "position": "Office Manager",
    "employeeId": "EM00123",
    "roleId": 4
  }
}

The Update User Details endpoint will be updated to not accept isActive and to return:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "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"
}

The Get Company-specific Details, Update Company-specific Details and Patch Company-specific Details endpoints will be update to return:

{
  "role": {
    "id": 4,
    "name": "Foreman",
    "slug": "foreman"
  },
  "isActive": true,
  "employeeId": "EM00123",
  "editTimer": true,
  "createTimer": true,
  "documentAccess": "read",
  "feedAccess": "read",
  "position": "Office Manager",
  "userId": 2,
  "companyId": 1
}

The Update Company-specific Details and Patch Company-specific Details endpoints will be updated to accept:

{
  "isActive": true,
  "editTimer": true,
  "createTimer": true,
  "documentAccess": "read",
  "feedAccess": "read",
  "position": "Office Manager",
  "employeeId": "EM00123"
}