{"id":444428,"date":"2026-04-03T02:43:22","date_gmt":"2026-04-03T00:43:22","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/rest-api-crud-operations\/"},"modified":"2026-04-03T02:43:22","modified_gmt":"2026-04-03T00:43:22","password":"","slug":"rest-api-crud-operations","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-crud-operations\/","title":{"rendered":"REST API – CRUD Operations"},"content":{"rendered":"
\n

ListTypes \u2014 List available modules<\/h2>\n

This operation returns all modules accessible via the API.<\/p>\n

\n

GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n

\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be listtypes<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

Curl example:<\/strong><\/p>\n

curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=listtypes&sessionName=YOUR_SESSION_ID\"\n<\/code><\/pre>\n
\n
Describe \u2014 Describe a module<\/h2>\n
This operation allows you to view a module’s fields (type, mandatory status) and available actions.<\/p>\n
\n
GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  describe<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n
elementType<\/code><\/td>\nstring<\/td>\nyes<\/td>\nModule name (e.g.: Contacts<\/code>)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=describe&sessionName=YOUR_SESSION_ID&elementType=Contacts\"\n<\/code><\/pre>\n
\n
Retrieve \u2014 Retrieve an entity<\/h2>\n
Retrieves a specific entity by its Webservice ID (e.g.: 21x3456<\/code>).<\/p>\n
\n
GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  retrieve<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n
id<\/code><\/td>\nstring<\/td>\nyes<\/td>\nEntity Webservice ID (e.g.: 21x3456<\/code>)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=retrieve&sessionName=YOUR_SESSION_ID&id=21x3456\"\n<\/code><\/pre>\n
\n
Create \u2014 Create an entity<\/h2>\n
Creates a new entity within a module. All mandatory fields must be included. Field values linked to other modules must use the Webservice IDs format (e.g.: 21x3456<\/code>).  <\/p>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  create<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n
element<\/code><\/td>\nJSON<\/td>\nyes<\/td>\nJSON object of the entity (fieldname: fieldvalue<\/code>)<\/td>\n<\/tr>\n
elementType<\/code><\/td>\nstring<\/td>\nyes<\/td>\nModule name (e.g.: Contacts<\/code>)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=create\" \\\n  -d \"sessionName=YOUR_SESSION_ID\" \\\n  -d 'element={\"lastname\":\"Dupont\",\"email\":\"dupont@example.com\",\"assigned_user_id\":\"19x1\"}' \\\n  -d \"elementType=Contacts\"\n<\/code><\/pre>\n
\n
Warning!<\/strong> For inventory modules (invoices, quotes, orders, etc.), it is mandatory to include the following fields in the element<\/code> object:<\/p>\n