Resources

Users

Users are personas in the system, organised in groups. To place a booking you need both a booking user and the group to book for.

Groups

Groups are organisational structures. A shipper can have an enterprise group with multiple subgroups that mirror its own structure — for example a European holding with per-country subgroups. Bookings can be placed on a subgroup.

Booking users

A booker is a user that has the Booker role inside a given group. The get-booking-users endpoint returns all users within your own enterprise that hold this role, grouped per (sub)group.

To make a booking with the API, you need to provide both the booker userId and the groupId of the (sub)group you want to place the booking for.

curl

curl https://api.ctrlchain.com/api/v1/User/get-booking-users \
  -H "apiKey: <your-api-key>"

Questions? info@ctrlchain.com Open the API reference →