Migration guide - CompanyUsersRestApi

Last updated:
Edit on GitHub

Upgrading from version 1.3.0 to version 2.0.0

In this version, the behavior of the GET company-users endpoint was changed. Now, it supports fetching of a single company user by uuid, a collection of company users available in a company, and a collection of Business-on-Behalf Company Users a user can impersonate as. Adjust your code to use new functionality:

  1. If you were using the /company-users endpoint to get available Business-on-Behalf Company Users, change it to /company-users/mine.

  2. Regenerate transfer objects:

vendor/bin/console transfer:generate
  1. Make sure that database schema is up to date:
vendor/bin/console propel:install
vendor/bin/console transfer:generate

Estimated migration time: ~5 minutes