J4.x

J4.x:Joomla Core APIs

From Joomla! Documentation

This page is a translated version of the page J4.x:Joomla Core APIs and the translation is 39% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎italiano
Joomla! 
4.0

Questa pagina elenca gli endpoint disponibili in Joomla mediante esempi di comandi di curl.

Ogni URL richiede autenticazione a meno che non sia designato un URL pubblico. Per motivi di sicurezza in Joomla 4.0.0 prevediamo che l'applicazione Api predefinita richieda un account Super User (poiché l'applicazione API è nuova di zecca), questo può essere rilassato poiché l'API si stabilizza ed è ben testato nella comunità. Se si utilizza il plug-in di autenticazione di base (attualmente l'unico plug-in fornito a partire da Joomla 4 alpha 10), è necessario aggiungere i seguenti comandi di curl usando --user nome_utente: password

If you are using the basic authentication plugin ("API Authentication - Web Services Basic Auth") it requires the addition to the curl commands below using --user user_name:password.

If you want to use the more secure token authentication (Bearer authentication) with activated plugins "API Authentication - Web Services Joomla Token" and "User - Joomla API Token" see the opener post on GitHub for examples how to add it to your curl commands.

Ogni URL deve essere anteposto all'host Joomla prima del percorso (ad es. Invece di /api/index.php/v1/article è necessario http://example.com/api/index.php/v1/article)

Qualsiasi nome di proprietà tra parentesi graffe ({}) indica che la proprietà è una variabile che deve essere sostituita.

Salvo diversamente specificato, queste API sono state introdotte in Joomla 4. Per ulteriori informazioni sulla specifica API Joomla (al contrario di questo elenco di URL e opzioni), si prega di visitare il Joomla Api Specification.

Where end points require the value of {app} the variable currently takes two values, site (Frontend), or Administrator (Backend).

Useful Resources

A number of complimentary resources have been created to introduce Joomla Web services and assist you with learning how to implement Web services on your project.

Banners

Banners

Ottieni l'elenco dei banner

curl -X GET /api/index.php/v1/banners

Ottieni un singolo Banner

curl -X GET /api/index.php/v1/banners/{banner_id}

Elimina Banner

curl -X DELETE /api/index.php/v1/banners/{banner_id}

Crea Banner

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners -d

{
    "catid": 3,
    "clicks": 0,
    "custombannercode": "",
    "description": "Text",
    "metakey": "",
    "name": "Name",
    "params": {
        "alt": "",
        "height": "",
        "imageurl": "",
        "width": ""
    }
}

Aggiorna Banner

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/{banner_id} -d

{
    "alias": "name",
    "catid": 3,
    "description": "New Text",
    "name": "New Name"
}

Clienti

Ottieni l'elenco dei Clienti

curl -X GET /api/index.php/v1/banners/clients

Ottieni singolo cliente

curl -X GET /api/index.php/v1/banners/clients/{client_id}

Elimina Cliente

curl -X DELETE /api/index.php/v1/banners/clients/{client_id}

Crea Cliente

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners/clients -d

{
    "contact": "Name",
    "email": "email@mail.com",
    "extrainfo": "",
    "metakey": "",
    "name": "Clients",
    "state": 1
}

Aggiorna Cliente

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/clients/{client_id} -d

{
    "contact": "new Name",
    "email": "newemail@mail.com",
    "name": "Clients"
}

Categorie

Ottieni l'elenco delle Categorie

curl -X GET /api/index.php/v1/banners/categories

Ottiene singola Categoria

curl -X GET /api/index.php/v1/banners/categories/{category_id}

Elimina Categoria

curl -X DELETE /api/index.php/v1/banners/categories/{category_id}

Crea Categoria

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners/categories -d

{
    "access": 1,
    "alias": "cat",
    "extension": "com_banners",
    "language": "*",
    "note": "",
    "parent_id": 1,
    "published": 1,
    "title": "Title"
}

Aggiorna Categoria

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/categories/{category_id} -d

{
    "alias": "cat",
    "note": "Some Text",
    "parent_id": 1,
    "title": "New Title"
}

Cronologia dei contenuti

Ottenere l'elenco delle storie di contenuti

curl -X GET /api/index.php/v1/banners/contenthistory/{banner_id}

Attivare e disattivare la cronologia dei contenuti

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/contenthistory/keep/{contenthistory_id}

Cancellare la cronologia dei contenuti

curl -X DELETE /api/index.php/v1/banners/contenthistory/{contenthistory_id}

Config

Applicatione

Ottenere l'elenco delle configurazioni delle applicazioni

curl -X GET /api/index.php/v1/config/application

Aggiornare la configurazione dell'applicazione

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/config/application -d

{
    "debug": true,
    "sitename": "123"
}

Componente

Ottenere l'elenco delle configurazioni dei componenti

curl -X GET /api/index.php/v1/config/{component_name}

Example “component_name” is “com_content”.

Aggiornare la configurazione dell'applicazione

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/config/application -d

{
    "link_titles": 1
}

Contatto

Contatto

Ottieni l'elenco dei Contatti

curl -X GET /api/index.php/v1/contacts

Get Single Contatto

curl -X GET /api/index.php/v1/contacts/{contact_id}

Elimina Contatto

curl -X DELETE /api/index.php/v1/contacts/{contact_id}

Crea Contatto

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/contacts -d

{
    "alias": "contact",
    "catid": 4,
    "language": "*",
    "name": "Contact"
}

Aggiorna Contatto

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/contacts/{contact_id} -d

{
    "alias": "contact",
    "catid": 4,
    "name": "New Contact"
}

Invia modulo di contatto

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/contacts/form/{contact_id} -d

{
    "contact_email": "email@mail.com",
    "contact_message": "some text",
    "contact_name": "name",
    "contact_subject": "subject"
}

Categorie

  1. Route Contact Categories is: "v1/contacts/categories"
  2. Working with it is similar to Banners Categories.

Campi Contatto

Ottieni l'elenco dei Campi Contatti

curl -X GET /api/index.php/v1/fields/contacts/contact

Ottenere un singolo contatto sul campo

curl -X GET /api/index.php/v1/fields/contacts/contact/{field_id}

Elimina contatto sul campo

curl -X DELETE /api/index.php/v1/fields/contacts/contact/{field_id}

Crea Campo Contatto

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/fields/contacts/contact -d

{
    "access": 1,
    "context": "com_contact.contact",
    "default_value": "",
    "description": "",
    "group_id": 0,
    "label": "contact field",
    "language": "*",
    "name": "contact-field",
    "note": "",
    "params": {
        "class": "",
        "display": "2",
        "display_readonly": "2",
        "hint": "",
        "label_class": "",
        "label_render_class": "",
        "layout": "",
        "prefix": "",
        "render_class": "",
        "show_on": "",
        "showlabel": "1",
        "suffix": ""
    },
    "required": 0,
    "state": 1,
    "title": "contact field",
    "type": "text"
}

Aggiorna Campo Contatto

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/fields/contacts/contact/{field_id} -d

{
    "title": "new contact field",
    "name": "contact-field",
    "label": "contact field",
    "default_value": "",
    "type": "text",
    "note": "",
    "description": "Some New Text"
}

Campi Contatto Posta

  1. Route Fields Contact Mail is: "v1/fields/contacts/mail"
  2. Working with it is similar to Fields Contact.

Fields Contact Categories

  1. Route Fields Contact Categories is: "v1/fields/contacts/categories"
  2. Working with it is similar to Fields Contact.

Groups Fields Contact

Get List of Groups Fields Contact

curl -X GET /api/index.php/v1/fields/groups/contacts/contact

Get Single Group Fields Contact

curl -X GET /api/index.php/v1/fields/groups/contacts/contact/{group_id}

Delete Group Fields Contact

curl -X DELETE /api/index.php/v1/fields/groups/contacts/contact/{group_id}

Create Group Fields Contact

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/fields/groups/contacts/contact -d

{
    "access": 1,
    "context": "com_contact.contact",
    "default_value": "",
    "description": "",
    "group_id": 0,
    "label": "contact field",
    "language": "*",
    "name": "contact-field3",
    "note": "",
    "params": {
        "class": "",
        "display": "2",
        "display_readonly": "2",
        "hint": "",
        "label_class": "",
        "label_render_class": "",
        "layout": "",
        "prefix": "",
        "render_class": "",
        "show_on": "",
        "showlabel": "1",
        "suffix": ""
    },
    "required": 0,
    "state": 1,
    "title": "contact field",
    "type": "text"
}

Update Group Fields Contact

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/fields/groups/contacts/contact/{group_id} -d

{
    "title": "new contact group",
    "note": "",
    "description": "new description"
}

Group Fields Contact Mail

#Route Group Fields Contact Mail is: "v1/fields/groups/contacts/mail" #Working with it is similar to Group Fields Contact.

Group Fields Contact Categories

#Route Group Fields Contact Categories is: "v1/fields/groups/contacts/categories" #Working with it is similar to Group Fields Contact.

Content History

#Route Content History is: "v1/contacts/{groupid}/contenthistory" #Working with it is similar to Banners Content History.

Contenuto

Articoli

Ottenere l'elenco degli articoli

curl -X GET /api/index.php/v1/content/articles

Get Single Article

curl -X GET /api/index.php/v1/content/articles/{article_id}

Elimina Articolo

curl -X DELETE /api/index.php/v1/content/articles/{article_id}

Crea Articolo

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/content/articles -d

{
    "alias": "my-article",
    "articletext": "My text",
    "catid": 64,
    "language": "*",
    "metadesc": "",
    "metakey": "",
    "title": "Here's an article"
}

Attualmente le opzioni menzionate qui sono proprietà obbligatorie. Tuttavia, al momento l'intenzione è di rendere AT MINIMO metakey e metadesc facoltativi nell'API.

Aggiorna Articolo

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/content/articles/{article_id} -d

{
    "catid": 64,
    "title": "Updated article"
}

Categorie

  1. Route Content Categories is: "v1/content/categories"
  2. Working with it is similar to Banners Categories, note if workflows is enabled then specifying a workflow is required (similarly to the UI).


Articoli sui campi

  1. Gli articoli sui campi di instradamento sono: "v1/fields/content/articles"
  2. Lavorare con esso è simile a Fields Contact.

Groups Fields Articles

#Route Groups Fields Articles is: "v1/fields/groups/content/articles" #Working with it is similar to Groups Fields Contact.

Fields Categories

#Route Fields Categories is: "v1/fields/groups/content/categories" #Working with it is similar to Fields Contact.

Content History

#Route Content History is: "v1/content/articles/{article_id}/contenthistory" #Working with it is similar to Banners Content History.

Le lingue

Le lingue

Ottieni l'elenco delle lingue

curl -X GET /api/index.php/v1/languages

Install Language

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages -d

{
    "package": "pkg_fr-FR"
}

Content Languages

Get List of Content Languages

curl -X GET /api/index.php/v1/languages/content

Get Single Content Language

curl -X GET /api/index.php/v1/v1/languages/content/{language_id}

Elimina lingua del contenuto

curl -X DELETE /api/index.php/v1/languages/content/{language_id}

Crea lingua dei contenuti

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/content -d

{
    "access": 1,
    "description": "",
    "image": "fr_FR",
    "lang_code": "fr-FR",
    "metadesc": "",
    "metakey": "",
    "ordering": 1,
    "published": 0,
    "sef": "fk",
    "sitename": "",
    "title": "French (FR)",
    "title_native": "Français (France)"
}

Aggiorna lingua del contenuto

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/languages/content/{language_id} -d

{
    "description": "",
    "lang_code": "en-GB",
    "metadesc": "",
    "metakey": "",
    "sitename": "",
    "title": "English (en-GB)",
    "title_native": "English (United Kingdom)"
}

Overrides Languages

Get List of Overrides Languages Constants

curl -X GET /api/index.php/v1/languages/overrides/{app}/{lang_code}

Get Single Override Language Constant

curl -X GET /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id}

Delete Content Language

curl -X DELETE /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id}

Create Content Language

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/{app}/{lang_code} -d

{
    "key":"new_key",
    "override": "text"
}

Update Content Language

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id} -d

{
    "key":"new_key",
    "override": "new text"
}

var app - enum {"site", "administrator"}

var lang_code - string Example: “fr-FR“, “en-GB“ you can get lang_code from v1/languages/content

Search Override Constant

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/search -d

{
    "searchstring": "JLIB_APPLICATION_ERROR_SAVE_FAILED",
    "searchtype": "constant"
}

var searchtype - enum {“constant”, “value”}. “constant” search by constant name, “value” - search by constant value

Refresh Override Search Cache

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/search/cache/refresh

Menus

Menus

Get List of Menus

curl -X GET /api/index.php/v1/menus/{app}

Get Single Menu

curl -X GET /api/index.php/v1/menus/{app}/{menu_id}

Delete Menu

curl -X DELETE /api/index.php/v1/menus/{app}/{menu_id}

Create Menu

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/menus/{app} -d

{
    "client_id": 0,
    "description": "The menu for the site",
    "menutype": "menu",
    "title": "Menu"
}

Update Menu

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/{menu_id} -d

{
    "menutype": "menu",
    "title": "New Menu"
}

Menus Items

Get List of Menus Items Types

curl -X GET /api/index.php/v1/menus/{app}/items/types

Get List of Menus Items

curl -X GET /api/index.php/v1/menus/{app}/items

Get Single Menu Item

curl -X GET /api/index.php/v1/menus/{app}/items/{menu_item_id}

Delete Menu Item

curl -X DELETE /api/index.php/v1/menus/{app}/items/{menu_item_id}

Create Menu Item

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/items -d

{
    "access": "1",
    "alias": "",
    "associations": {
        "en-GB": "",
        "fr-FR": ""
    },
    "browserNav": "0",
    "component_id": "20",
    "home": "0",
    "language": "*",
    "link": "index.php?option=com_content&view=form&layout=edit",
    "menutype": "mainmenu",
    "note": "",
    "params": {
        "cancel_redirect_menuitem": "",
        "catid": "",
        "custom_cancel_redirect": "0",
        "enable_category": "0",
        "menu-anchor_css": "",
        "menu-anchor_title": "",
        "menu-meta_description": "",
        "menu-meta_keywords": "",
        "menu_image": "",
        "menu_image_css": "",
        "menu_show": "1",
        "menu_text": "1",
        "page_heading": "",
        "page_title": "",
        "pageclass_sfx": "",
        "redirect_menuitem": "",
        "robots": "",
        "show_page_heading": ""
    },
    "parent_id": "1",
    "publish_down": "",
    "publish_up": "",
    "published": "1",
    "template_style_id": "0",
    "title": "title",
    "toggle_modules_assigned": "1",
    "toggle_modules_published": "1",
    "type": "component"
}

Example for "Create Article Page"

Update Menu Item

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/items/{menu_item_id} -d

{
    "component_id": "20",
    "language": "*",
    "link": "index.php?option=com_content&view=form&layout=edit",
    "menutype": "mainmenu",
    "note": "",
    "title": "new title",
    "type": "component"
}

Example for "Create Article Page"

Messages

Messages

Get List of Messages

curl -X GET /api/index.php/v1/messages

Get Single Message

curl -X GET /api/index.php/v1/messages/{message_id}

Delete Message

curl -X DELETE /api/index.php/v1/messages/{message_id}

Create Message

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/messages -d

{
    "message": "<p>text</p>",
    "state": 0,
    "subject": "text",
    "user_id_from": 773,
    "user_id_to": 772
}

Update Message

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/messages/{message_id} -d

{
    "message": "<p>new text</p>",
    "subject": "new text",
    "user_id_from": 773,
    "user_id_to": 772
}

Modules

Modules

Get List of Modules Types

curl -X GET /api/index.php/v1/modules/types/{app}

Get List of Modules

curl -X GET /api/index.php/v1/modules/{app}

Get Single Module

curl -X GET /api/index.php/v1/modules/{app}/{module_id}

Delete Module

curl -X DELETE /api/index.php/v1/modules/{app}/{module_id}

Create Module

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/modules/{app} -d

{
    "access": "1",
    "assigned": [
        "101",
        "105"
    ],
    "assignment": "0",
    "client_id": "0",
    "language": "*",
    "module": "mod_articles_archive",
    "note": "",
    "ordering": "1",
    "params": {
        "bootstrap_size": "0",
        "cache": "1",
        "cache_time": "900",
        "cachemode": "static",
        "count": "10",
        "header_class": "",
        "header_tag": "h3",
        "layout": "_:default",
        "module_tag": "div",
        "moduleclass_sfx": "",
        "style": "0"
    },
    "position": "",
    "publish_down": "",
    "publish_up": "",
    "published": "1",
    "showtitle": "1",
    "title": "Title"
}

Example for "Articles - Archived"

Update Module

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/modules/{app}/{module_id} -d

{
    "access": "1",
    "client_id": "0",
    "language": "*",
    "module": "mod_articles_archive",
    "note": "",
    "ordering": "1",
    "title": "New Title"
}

Example for "Articles - Archived"

Newsfeeds

Feeds

Get List of Feeds

curl -X GET /api/index.php/v1/newsfeeds/feeds

Get Single Feed

curl -X GET /api/index.php/v1/newsfeeds/feeds/{feed_id}

Delete Feed

curl -X DELETE /api/index.php/v1/newsfeeds/feeds/{feed_id}

Create Feed

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/newsfeeds/feeds -d

{
    "access": 1,
    "alias": "alias",
    "catid": 5,
    "description": "",
    "images": {
        "float_first": "",
        "float_second": "",
        "image_first": "",
        "image_first_alt": "",
        "image_first_caption": "",
        "image_second": "",
        "image_second_alt": "",
        "image_second_caption": ""
    },
    "language": "*",
    "link": "https://github.com/joomla-projects/gsoc19_webservices",
    "metadata": {
        "hits": "",
        "rights": "",
        "robots": "",
        "tags": {
            "tags": "",
            "typeAlias": null
        }
    },
    "metadesc": "",
    "metakey": "",
    "name": "Name",
    "ordering": 1,
    "params": {
        "feed_character_count": "",
        "feed_display_order": "",
        "newsfeed_layout": "",
        "show_feed_description": "",
        "show_feed_image": "",
        "show_item_description": ""
    },
    "published": 1
}

Update Feed

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/newsfeeds/feeds/{feed_id} -d

{
    "access": 1,
    "alias": "test2",
    "catid": 5,
    "description": "",
    "link": "https://github.com/joomla-projects/gsoc19_webservices",
    "metadesc": "",
    "metakey": "",
    "name": "Test"
}

Categories

#Route Newsfeeds Categories is: "v1/newsfeeds/categories" #Working with it is similar to Banners Categories.

Privacy

Request

Ottenere l'elenco delle richieste

curl -X GET /api/index.php/v1/privacy/requests

Richiesta singola

curl -X GET /api/index.php/v1/privacy/requests/{request_id}

Ottenere i dati di esportazione a richiesta singola

curl -X GET /api/index.php/v1/privacy/request/export/{request_id}

Crea Richiesta

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/privacy/requests -d

{
    "email":"somenewemail@com.ua",
    "request_type":"export"
}

Consenso

Ottenere l'elenco dei consensi

curl -X GET /api/index.php/v1/privacy/consents

Ottenere il consenso singolo

curl -X GET /api/index.php/v1/privacy/consents/{consent_id}

Reindirizzamento

Reindirizzamento

Ottenere l'elenco dei reindirizzamenti

curl -X GET /api/index.php/v1/redirect

Get Single Redirect

curl -X GET /api/index.php/v1/redirect/{redirect_id}

Delete Redirect

curl -X DELETE /api/index.php/v1/redirect/{redirect_id}

Create Redirect

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/redirect -d

{
    "comment": "",
    "header": 301,
    "hits": 0,
    "new_url": "/content/art/99",
    "old_url": "/content/art/12",
    "published": 1,
    "referer": ""
}

Update Redirect

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/redirect/{redirect_id} -d

{
    "new_url": "/content/art/4",
    "old_url": "/content/art/132"
}

Tags

Tags

Get List of Tags

curl -X GET /api/index.php/v1/tags

Get Single Tag

curl -X GET /api/index.php/v1/tags/{tag_id}

Delete Tag

curl -X DELETE /api/index.php/v1/tags/{tag_id}

Create Tag

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/tags -d

{
    "access": 1,
    "access_title": "Public",
    "alias": "test",
    "description": "",
    "language": "*",
    "note": "",
    "parent_id": 1,
    "path": "test",
    "published": 1,
    "title": "test"
}

Update Tag

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/tags/{tag_id} -d

{
    "alias": "test",
    "title": "new title"
}

Templates

Templates Styles

Get List of Templates Styles

curl -X GET /api/index.php/v1/templates/styles/{app}

Get Single Template Style

curl -X GET /api/index.php/v1/templates/styles/{app}/{template_style_id}

Delete Template Style

curl -X DELETE /api/index.php/v1/templates/styles/{app}/{template_style_id}

Create Template Style

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/templates/styles/{app} -d

{
    "home": "0",
    "params": {
        "fluidContainer": "0",
        "logoFile": "",
        "sidebarLeftWidth": "3",
        "sidebarRightWidth": "3"
    },
    "template": "cassiopeia",
    "title": "cassiopeia - Some Text"
}

Update Template Style

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/templates/styles/{app}/{template_style_id} -d

{
	"template": "cassiopeia",
	"title": "new cassiopeia - Default"
}

Utenti

Utenti

Ottenere l'elenco degli utenti

curl -X GET /api/index.php/v1/users

Ottenere un singolo utente

curl -X GET /api/index.php/v1/users/{user_id}

Elimina Utente

curl -X DELETE /api/index.php/v1/users/{user_id}

Creare utente

curl -X POST -H "Content-Type: application/json" /api/index.php/v1/users -d

{
    "block": "0",
    "email": "test@mail.com",
    "groups": [
        "2"
    ],
    "id": "0",
    "lastResetTime": "",
    "lastvisitDate": "",
    "name": "nnn",
    "params": {
        "admin_language": "",
        "admin_style": "",
        "editor": "",
        "helpsite": "",
        "language": "",
        "timezone": ""
    },
    "password": "qwertyqwerty123",
    "password2": "qwertyqwerty123",
    "registerDate": "",
    "requireReset": "0",
    "resetCount": "0",
    "sendEmail": "0",
    "username": "ad"
}

Update User

curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/users/{user_id} -d

{
    "email": "new@mail.com",
    "groups": [
        "2"
    ],
    "name": "name",
    "username": "username"
}

Fields Users

#Route Fields Users is: v1/fields/users #Working with it is similar to Fields Contact.

Groups Fields Users

#Route Groups Fields Users is: v1/fields/groups/users #Working with it is similar to Groups Fields Contact.