---
seo:
  description: Profiles, roles, invites, contact details, and user groups.
sidebar:
  label: Overview
title: Fuxam API v4
---
Profiles, roles, invites, contact details, and user groups.

Version 4.3.0

Base URL: `https://fuxam.app/api/v4`, `https://dev.fuxam.app/api/v4`

## Users

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

- [`GET /users`](/docs/api/users/users/list-users) — List users.
- [`POST /users`](/docs/api/users/users/create-user) — Create a user.
- [`PUT /users`](/docs/api/users/users/upsert-user) — Create or update a user by membership code.
- [`GET /users/{id}`](/docs/api/users/users/get-user) — Get a user.
- [`PATCH /users/{id}`](/docs/api/users/users/update-user) — Update a user.
- [`DELETE /users/{id}`](/docs/api/users/users/delete-user) — Remove a user from the institution.
- [`PATCH /users/{id}/activity`](/docs/api/users/users/update-user-activity) — Update user activity.
- [`GET /users/{id}/notes`](/docs/api/users/users/list-user-notes) — List user notes.
- [`POST /users/{id}/notes`](/docs/api/users/users/create-user-note) — Add a note.
- [`PATCH /users/{id}/notes/{noteId}`](/docs/api/users/users/update-user-note) — Update a note.
- [`DELETE /users/{id}/notes/{noteId}`](/docs/api/users/users/delete-user-note) — Delete a note.

## Roles & access

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

- [`GET /roles`](/docs/api/users/users-roles-access/list-roles) — List institution roles.
- [`GET /users/{id}/roles`](/docs/api/users/users-roles-access/list-user-roles) — List user role assignments.
- [`POST /users/{id}/roles`](/docs/api/users/users-roles-access/assign-role) — Assign a role to a user.
- [`DELETE /users/{id}/roles/{assignmentId}`](/docs/api/users/users-roles-access/revoke-role) — Revoke a role assignment.
- [`PUT /users/{id}/primary-role`](/docs/api/users/users-roles-access/set-primary-role) — Set primary organisation role.
- [`POST /users/{id}/access-packages`](/docs/api/users/users-roles-access/assign-user-access-package) — Assign an access package to a user.
- [`DELETE /users/{id}/access-packages`](/docs/api/users/users-roles-access/revoke-user-access-package) — Revoke an access package from a user.

## Data fields

Custom data field values and collection requests

- [`POST /users/{id}/data-collection-requests`](/docs/api/users/users-data-fields/create-user-data-collection-request) — Request missing user data fields.
- [`GET /users/{id}/data-fields`](/docs/api/users/users-data-fields/get-user-data-fields) — Get user data fields.
- [`PATCH /users/{id}/data-fields`](/docs/api/users/users-data-fields/update-user-data-fields) — Upsert user data field values.

## Invites

Pending invites and resend

- [`GET /invites`](/docs/api/users/users-invites/list-invites) — List pending invites.
- [`POST /invites/{id}/resend`](/docs/api/users/users-invites/resend-invite) — Resend an invite email.

## Contact details

Emails, phones, and addresses

- [`GET /users/{id}/emails`](/docs/api/users/users-contact-details/list-user-emails) — List user emails.
- [`POST /users/{id}/emails`](/docs/api/users/users-contact-details/create-user-email) — Add an email.
- [`PATCH /users/{id}/emails/{emailId}`](/docs/api/users/users-contact-details/update-user-email) — Update an email.
- [`DELETE /users/{id}/emails/{emailId}`](/docs/api/users/users-contact-details/delete-user-email) — Delete an email.
- [`GET /users/{id}/phones`](/docs/api/users/users-contact-details/list-user-phones) — List user phones.
- [`POST /users/{id}/phones`](/docs/api/users/users-contact-details/create-user-phone) — Add a phone.
- [`PATCH /users/{id}/phones/{phoneId}`](/docs/api/users/users-contact-details/update-user-phone) — Update a phone.
- [`DELETE /users/{id}/phones/{phoneId}`](/docs/api/users/users-contact-details/delete-user-phone) — Delete a phone.
- [`GET /users/{id}/addresses`](/docs/api/users/users-contact-details/list-user-addresses) — List user addresses.
- [`POST /users/{id}/addresses`](/docs/api/users/users-contact-details/create-user-address) — Add an address.
- [`PATCH /users/{id}/addresses/{addressId}`](/docs/api/users/users-contact-details/update-user-address) — Update an address.
- [`DELETE /users/{id}/addresses/{addressId}`](/docs/api/users/users-contact-details/delete-user-address) — Delete an address.

## User groups

User groups and group memberships

- [`GET /users/user-groups`](/docs/api/users/users-user-groups/list-user-groups) — List user groups.
- [`POST /users/user-groups`](/docs/api/users/users-user-groups/create-user-group) — Create a user group.
- [`GET /users/user-groups/{id}`](/docs/api/users/users-user-groups/get-user-group) — Get a user group.
- [`PATCH /users/user-groups/{id}`](/docs/api/users/users-user-groups/update-user-group) — Update a user group.
- [`DELETE /users/user-groups/{id}`](/docs/api/users/users-user-groups/delete-user-group) — Delete a user group.
- [`GET /users/user-groups/{id}/members`](/docs/api/users/users-user-groups/list-group-members) — List members of a user group.
- [`POST /users/user-groups/{id}/members`](/docs/api/users/users-user-groups/add-group-members) — Add members to a user group.
- [`DELETE /users/user-groups/{id}/members/{userId}`](/docs/api/users/users-user-groups/remove-group-member) — Remove a member from a user group.
- [`GET /users/{id}/groups`](/docs/api/users/users-user-groups/list-user-group-memberships) — List groups a user belongs to.