Hoi 👋🏻 kunnen we je helpen?

Zoeken

Gebruikers beheren via de API

Article author
Shannon Bolink-Tieman
  • Bijgewerkt

Via de API kun je gebruikers aanmaken, opzoeken, bijwerken, blokkeren en verwijderen. Ook kun je gebruikers koppelen aan bedrijven en contexten.

Endpoints

MethodeEndpointBeschrijving
GET/api/v1/usersAlle gebruikers opvragen (gepagineerd)
GET/api/v1/user/get_by_email?email={email}Gebruiker opzoeken op e-mailadres
GET/api/v1/user/get_by_id/{id}Gebruiker opzoeken op ID
PUT/api/v1/user/addNieuwe gebruiker aanmaken
PATCH/api/v1/user/{id}/updateGebruiker bijwerken
DELETE/api/v1/user/{id}/deleteGebruiker verwijderen
POST/api/v1/user/{id}/blockGebruiker blokkeren
POST/api/v1/user/{id}/unblockGebruiker deblokkeren
GET/api/v1/account/usersAlle gebruikers van het account

Gebruiker aanmaken

PUT /api/v1/user/add
Content-Type: application/json

{
  "first_name": "Jan",
  "last_name": "Janssen",
  "email": "jan@example.nl"
}

Gebruiker opzoeken op e-mailadres

GET /api/v1/user/get_by_email?email=jan@example.nl

Gebruiker blokkeren

Een geblokkeerde gebruiker kan niet meer inloggen, maar blijft zichtbaar in het systeem. Dit is de aanbevolen methode als een medewerker tijdelijk geen toegang mag hebben.

POST /api/v1/user/42/block

Gebruiker verwijderen

Bij verwijdering wordt de gebruiker permanent uit het systeem gehaald. Dit kan niet ongedaan worden gemaakt.

DELETE /api/v1/user/42/delete

Gebruiker koppelen aan context/groep

POST /api/v1/groups/add_user_membership
Content-Type: application/json

{
  "user_id": 42,
  "group_id": 7
}