Skip to content

Users

People who use Brooklyn, their profiles and what they own.

Base path
/user

Endpoints

34 endpoints

Method

Standard Operations

7
  • GET /user List users (with search, filters and paging).
  • POST /user Create a new user.
  • PATCH /user/bulk Update several users at once.
  • GET /user/{id} Open a single user.
  • PUT /user/{id} Replace a user's details in full.
  • PATCH /user/{id} Edit a user.
  • DELETE /user/{id} Delete a user.

Additional Operations

27
  • POST /user/all List users matching a set of IDs.
  • GET /user/managers List users who can be managers.
  • PATCH /user/{id}/credentials Change a user's sign-in details.
  • GET /user/owners List users who can own records.
  • GET /user/{userId}/contracts List the contracts a user owns.
  • GET /user/{cognitoId}/committees List the committees a user belongs to.
  • GET /user/{cognitoId}/services List the services a user is responsible for.
  • GET /user/{cognitoId}/vendors List the vendors a user is responsible for.
  • GET /user/email Find a user by email address.
  • GET /user/main Show the signed-in user's main details.
  • DELETE /user/email/{email} Delete a user by email address.
  • GET /user/contacts List contacts (people outside your organisation).
  • GET /user/people List people.
  • GET /user/role Show the signed-in user's role.
  • PATCH /user/user-cognito Update a user's sign-in account.
  • GET /user/profile/{id} Show a user's profile.
  • PATCH /user/profile/{id} Edit a user's profile.
  • GET /user/profile Show my profile.
  • POST /user/csv Download the users list as a spreadsheet.
  • GET /user/usersWork Show how much work each user has.
  • GET /user/{id}/reassignable-items List work that can be handed from one user to another.
  • POST /user/{id}/reassign-items/execute Carry out a handover of work to another user.
  • POST /user/{id}/reassign-items/complete Mark a work handover as finished.
  • POST /user/{id}/reassign-items Start handing a user's work to someone else.
  • GET /user/usersWorkGuidance Show guidance on balancing users' workloads.
  • POST /user/usersWorkGuidance/refresh Recalculate workload guidance.
  • POST /user/usersWorkGuidance/configuration Change workload guidance settings.