Users API

De Users API biedt endpoints voor het beheren van gebruikers in Joomla.

Base URL

/api/index.php/v1/users

Endpoints Overzicht

Methode	Endpoint	Beschrijving
GET	/users	Alle gebruikers ophalen
GET	/users/{id}	Specifieke gebruiker ophalen
POST	/users	Nieuwe gebruiker aanmaken
PATCH	/users/{id}	Gebruiker bijwerken
DELETE	/users/{id}	Gebruiker verwijderen

Alle gebruikers ophalen

GET /api/index.php/v1/users

Response

{
    "data": [
        {
            "type": "users",
            "id": "42",
            "attributes": {
                "name": "John Doe",
                "username": "johndoe",
                "email": "john@example.com",
                "registerDate": "2024-01-01 12:00:00",
                "lastvisitDate": "2024-10-26 10:30:00",
                "block": 0
            }
        }
    ]
}

Specifieke gebruiker ophalen

GET /api/index.php/v1/users/{id}

Parameters

Parameter	Type	Beschrijving
id	integer	Gebruiker ID

Voorbeeld

curl -X GET "https://jouwesite.nl/api/index.php/v1/users/42" \
  -H "X-Joomla-Token: JOUW_API_TOKEN"

Gebruiker aanmaken

POST /api/index.php/v1/users

Request Body

{
    "name": "Jane Doe",
    "username": "janedoe",
    "email": "jane@example.com",
    "password": "SecurePassword123!",
    "groups": [2]
}

Verplichte velden

Veld	Type	Beschrijving
name	string	Volledige naam
username	string	Gebruikersnaam (uniek)
email	string	E-mailadres (uniek)
password	string	Wachtwoord

Optionele velden

Veld	Type	Standaard	Beschrijving
groups	array	[2]	Groep IDs
block	int	0	Geblokkeerd (0=nee, 1=ja)
params	object		Extra parameters

Voorbeeld

curl -X POST "https://jouwesite.nl/api/index.php/v1/users" \
  -H "X-Joomla-Token: JOUW_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "username": "janedoe",
    "email": "jane@example.com",
    "password": "SecurePassword123!",
    "groups": [2]
  }'

Gebruiker bijwerken

PATCH /api/index.php/v1/users/{id}

Request Body

{
    "name": "Jane Smith",
    "email": "jane.smith@example.com"
}

Voorbeeld

curl -X PATCH "https://jouwesite.nl/api/index.php/v1/users/42" \
  -H "X-Joomla-Token: JOUW_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Smith",
    "email": "jane.smith@example.com"
  }'

Gebruiker verwijderen

DELETE /api/index.php/v1/users/{id}

Voorbeeld

curl -X DELETE "https://jouwesite.nl/api/index.php/v1/users/42" \
  -H "X-Joomla-Token: JOUW_API_TOKEN"

Let op

Het verwijderen van een gebruiker is permanent en kan niet ongedaan worden gemaakt.

Gebruiker blokkeren/deblokkeren

Om een gebruiker te blokkeren, gebruik de PATCH methode:

curl -X PATCH "https://jouwesite.nl/api/index.php/v1/users/42" \
  -H "X-Joomla-Token: JOUW_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"block": 1}'

User Groups

Standaard Joomla Groepen

ID	Naam	Beschrijving
1	Public	Publieke toegang
2	Registered	Geregistreerde gebruikers
3	Author	Auteurs
4	Editor	Editors
5	Publisher	Publishers
6	Manager	Managers
7	Administrator	Administrators
8	Super Users	Super Users

Filtering

Op naam zoeken

GET /api/index.php/v1/users?filter[search]=john

Op groep

GET /api/index.php/v1/users?filter[group]=2

Geblokkeerde gebruikers

GET /api/index.php/v1/users?filter[block]=1

Gerelateerde Endpoints

• User Fields - Custom velden voor gebruikers
• User Field Groups - Groepering van custom velden