Fuxam API v4

Profiles, roles, invites, contact details, and user groups.

Users

Core profile, membership, lifecycle, and institution demographics. Membership code is one namespace per institution across students, staff, lecturers, and badge numbers.

• GET
  List users/users
• POST
  Create a user/users
• PUT
  Create or update a user by membership code/users
• GET
  Get a user/users/{id}
• PATCH
  Update a user/users/{id}
• DELETE
  Remove a user from the institution/users/{id}
• PATCH
  Update user activity/users/{id}/activity
• GET
  List user notes/users/{id}/notes
• POST
  Add a note/users/{id}/notes
• PATCH
  Update a note/users/{id}/notes/{noteId}
• DELETE
  Delete a note/users/{id}/notes/{noteId}

Roles & access

Institution roles, scoped role grants, primary role, and access packages

• GET
  List institution roles/roles
• GET
  List user role assignments/users/{id}/roles
• POST
  Assign a role to a user/users/{id}/roles
• DELETE
  Revoke a role assignment/users/{id}/roles/{assignmentId}
• PUT
  Set primary organisation role/users/{id}/primary-role
• POST
  Assign an access package to a user/users/{id}/access-packages
• DELETE
  Revoke an access package from a user/users/{id}/access-packages

Data fields

Custom data field values and collection requests

• POST
  Request missing user data fields/users/{id}/data-collection-requests
• GET
  Get user data fields/users/{id}/data-fields
• PATCH
  Upsert user data field values/users/{id}/data-fields

Invites

Pending invites and resend

• GET
  List pending invites/invites
• POST
  Resend an invite email/invites/{id}/resend

Contact details

Emails, phones, and addresses

• GET
  List user emails/users/{id}/emails
• POST
  Add an email/users/{id}/emails
• PATCH
  Update an email/users/{id}/emails/{emailId}
• DELETE
  Delete an email/users/{id}/emails/{emailId}
• GET
  List user phones/users/{id}/phones
• POST
  Add a phone/users/{id}/phones
• PATCH
  Update a phone/users/{id}/phones/{phoneId}
• DELETE
  Delete a phone/users/{id}/phones/{phoneId}
• GET
  List user addresses/users/{id}/addresses
• POST
  Add an address/users/{id}/addresses
• PATCH
  Update an address/users/{id}/addresses/{addressId}
• DELETE
  Delete an address/users/{id}/addresses/{addressId}

User groups

User groups and group memberships

• GET
  List user groups/users/user-groups
• POST
  Create a user group/users/user-groups
• GET
  Get a user group/users/user-groups/{id}
• PATCH
  Update a user group/users/user-groups/{id}
• DELETE
  Delete a user group/users/user-groups/{id}
• GET
  List members of a user group/users/user-groups/{id}/members
• POST
  Add members to a user group/users/user-groups/{id}/members
• DELETE
  Remove a member from a user group/users/user-groups/{id}/members/{userId}
• GET
  List groups a user belongs to/users/{id}/groups