Developer docs
De Pluvo API geeft je programmatische toegang tot je leeromgeving. Beheer gebruikers, groepen, trainingen, inschrijvingen en certificaten vanuit je eigen systemen.
De API is gebaseerd op GraphQL. Je bepaalt zelf welke data je opvraagt of muteert, zonder overbodige velden. Authenticatie verloopt via OAuth 2.0 met client credentials. Webhooks houden je systemen real-time op de hoogte van wijzigingen.
Use Cases
Add users to group
Adds one or more users to an existing group as participants. Users already in the group are reported under alreadyAddedIds.
mutation {
addUsersToGroup(
groupId: "group-uuid"
userIds: ["user-uuid-1", "user-uuid-2"]
) {
addedIds
alreadyAddedIds
failedIds
}
}You can also use ref instead of id for both the group and users:
mutation {
addUsersToGroup(
groupRef: "group-sales"
userRefs: ["EMP-001", "EMP-002"]
) {
addedIds
alreadyAddedIds
failedIds
}
}Remove users from group
Removes users from a group. The response indicates which users were actually removed.
mutation {
removeUsersFromGroup(
groupId: "group-uuid"
userIds: ["user-uuid-1"]
) {
removedIds
alreadyRemovedIds
failedIds
}
}Add managers to group
Adds one or more users as managers to a group. This gives them administrative rights within that group.
mutation {
addManagersToGroup(
groupId: "group-uuid"
userIds: ["user-uuid-1"]
) {
response {
succeededIds
failedIds
}
}
}Remove managers from group
Removes one or more users as managers from a group.
mutation {
removeManagersFromGroup(
groupId: "group-uuid"
userIds: ["user-uuid-1"]
) {
response {
succeededIds
failedIds
}
}
}GraphQL Definitions
Mutations
All mutations support both id and ref for identification of groups and users.
addUsersToGroup(
groupId: UUID, groupRef: String,
userIds: [UUID!], userRefs: [String!]
): AddUsersToGroup
removeUsersFromGroup(
groupId: UUID, groupRef: String,
userIds: [UUID!], userRefs: [String!]
): RemoveUsersFromGroup
addManagersToGroup(
groupId: UUID, groupRef: String,
userIds: [UUID!], userRefs: [String!]
): AddManagersToGroup
removeManagersFromGroup(
groupId: UUID, groupRef: String,
userIds: [UUID!], userRefs: [String!]
): RemoveManagersFromGroupNotes
- Both
idandrefcan be used for groups (groupId/groupRef) and users (userIds/userRefs). Use whichever is most convenient for your integration. - The response clearly indicates which operations succeeded, which were already in the desired state, and which failed.
- A user can be both a participant and a manager in the same group — these are managed independently.
- For bulk user sync, combine
updateOrCreateUserwithaddUsersToGroupusingreffields for reliable matching.