Users API endpoints
The Users app exposes accounts, groups, laboratories and the invitation and request records that manage membership.
Resources
| Resource | What it is | Portals |
|---|---|---|
user | A person with a BrainSTEM account, who receives roles directly or through groups. | private, public |
group | A set of users, such as a lab or a team, that can be given a role as one. | private, public |
laboratory | Laboratory records. | private, public |
Supporting endpoints
Approval requests, membership invitations and link tables. Most workflows never call these directly; the main resources create and resolve them.
| Resource | What it is | Portals |
|---|---|---|
groupmembershipinvitation | Group membership invitation records. | private |
groupmembershiprequest | Group membership request records. | private |
pendinginvitation | An invitation by email to someone without an account yet, for a role on a group, project or personal attribute; it takes effect when they sign up. | private |
All endpoints follow https://www.brainstem.org/api/{portal}/users/{resource}/ and support the common query parameters.