{"id":444465,"date":"2026-04-03T02:43:18","date_gmt":"2026-04-03T00:43:18","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/rest-api-requests-and-querying\/"},"modified":"2026-04-03T02:43:18","modified_gmt":"2026-04-03T00:43:18","password":"","slug":"rest-api-requests-and-querying","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/","title":{"rendered":"REST API &#8211; Requests and Querying"},"content":{"rendered":"<hr>\n<h2>Query \u2014 Querying the Database<\/h2>\n<p>This operation allows you to perform a SELECT query. The query must follow a specific format and has certain limitations: <\/p>\n<ul>\n<li>Only one entity type per query (no JOIN)<\/li>\n<li>Maximum 100 results per query (use <code>LIMIT<\/code> and <code>OFFSET<\/code> to paginate)<\/li>\n<li>The <code>WHERE<\/code>, <code>ORDER BY<\/code>, and <code>LIMIT<\/code> clauses are optional<\/li>\n<li>The query must be URL-encoded<\/li>\n<\/ul>\n<blockquote>\n<p><strong>GET<\/strong> <code>https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>operation<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>Must be  <code>query<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>sessionName<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>Session identifier<\/td>\n<\/tr>\n<tr>\n<td><code>query<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>SQL query (URL-encoded)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<p><strong>curl example:<\/strong><\/p>\n<pre><code class=\"language-bash\">curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=query&sessionName=YOUR_SESSION_ID&query=SELECT%20*%20FROM%20Contacts%20WHERE%20lastname%3D'Dupont'%20LIMIT%2010%20;\"\n<\/code><\/pre>\n<h3>Query Format<\/h3>\n<pre><code class=\"language-sql\">SELECT * | ColumnsList | count(*)\nFROM ModuleName\nWHERE Conditions\nORDER BY ColumnsList\nLIMIT Offset, Limit ;\n<\/code><\/pre>\n<blockquote class=\"bq-important\">\n<p><strong>Important:<\/strong> the final semicolon is mandatory.<\/p>\n<\/blockquote>\n<p><strong>Details:<\/strong><\/p>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>Element<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>ColumnsList<\/code><\/td>\n<td>List of field names separated by commas<\/td>\n<\/tr>\n<tr>\n<td><code>ModuleName<\/code><\/td>\n<td>Entity module name<\/td>\n<\/tr>\n<tr>\n<td><code>Conditions<\/code><\/td>\n<td>Separated by <code>AND<\/code> or <code>OR<\/code>, processed from left to right. No grouping with parentheses. <\/td>\n<\/tr>\n<tr>\n<td><code>Offset<\/code><\/td>\n<td>Integer (optional)<\/td>\n<\/tr>\n<tr>\n<td><code>Limit<\/code><\/td>\n<td>Integer<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<p><strong>Available condition types:<\/strong><\/p>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>Type<\/th>\n<th>Syntax<\/th>\n<th>Example<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Operator<\/td>\n<td><code>&lt;<\/code>, <code>&gt;<\/code>, <code>&lt;=<\/code>, <code>&gt;=<\/code>, <code>!=<\/code>,  <code>=<\/code><\/td>\n<td><code>lastname = 'Dupont'<\/code><\/td>\n<\/tr>\n<tr>\n<td>IN<\/td>\n<td><code>IN(val1, val2, ...)<\/code><\/td>\n<td><code>industry IN('Tech', 'Finance')<\/code><\/td>\n<\/tr>\n<tr>\n<td>LIKE<\/td>\n<td><code>LIKE 'pattern'<\/code><\/td>\n<td><code>lastname LIKE '%dup%'<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<hr>\n<h2>Query Related \u2014 Querying Related Lists<\/h2>\n<p>This operation allows you to retrieve entities from the related lists of a specific entity. The query follows the same format as <code>query<\/code>, but <strong>without a final semicolon<\/strong>. <\/p>\n<blockquote>\n<p><strong>GET<\/strong> <code>https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>operation<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>Must be  <code>query_related<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>sessionName<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>Session identifier<\/td>\n<\/tr>\n<tr>\n<td><code>id<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>Webservice ID of the parent entity<\/td>\n<\/tr>\n<tr>\n<td><code>relatedLabel<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>Related module name<\/td>\n<\/tr>\n<tr>\n<td><code>query<\/code><\/td>\n<td>string<\/td>\n<td>yes<\/td>\n<td>SQL query (URL-encoded, without final <code>;<\/code>)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<p><strong>curl example:<\/strong><\/p>\n<pre><code class=\"language-bash\">curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=query_related&sessionName=YOUR_SESSION_ID&id=21x3456&relatedLabel=Documents&query=SELECT%20*%20FROM%20Documents%20WHERE%20filesize%20%3E%2010000\"\n<\/code><\/pre>\n<p><strong>Query example:<\/strong><\/p>\n<pre><code class=\"language-sql\">SELECT * FROM Documents WHERE filesize &gt; 10000\n<\/code><\/pre>\n<hr>\n<h2>Related References \ud83d\udd17<\/h2>\n<ul>\n<li><a href=\"https:\/\/www.kafinea.com\/en\/documentation\/api\/rest-api-crud-operations\/\">CRUD Operations<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/en\/documentation\/api\/rest-api-introduction\/\">API Introduction<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Query \u2014 Querying the Database This operation allows you to perform a SELECT query. The query must follow a specific format and has certain limitations: Only one entity type per query (no JOIN) Maximum 100 results per query (use LIMIT and OFFSET to paginate) The WHERE, ORDER BY, and LIMIT clauses are optional The query&#8230;<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_uag_custom_page_level_css":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","footnotes":""},"doc_category":[759],"doc_tag":[],"class_list":["post-444465","docs","type-docs","status-publish","hentry","doc_category-api"],"year_month":"2026-08","word_count":316,"total_views":"2","reactions":{"happy":"0","normal":"0","sad":"0"},"author_info":{"name":"David Valminos","author_nicename":"david","author_url":"https:\/\/www.kafinea.com\/en\/author\/david\/"},"doc_category_info":[{"term_name":"API","term_url":"https:\/\/www.kafinea.com\/en\/help\/api\/"}],"doc_tag_info":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.1 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Help - REST API - Requests and Querying &#8226; Kafinea<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Help - REST API - Requests and Querying &#8226; Kafinea\" \/>\n<meta property=\"og:description\" content=\"Query \u2014 Querying the Database This operation allows you to perform a SELECT query. The query must follow a specific format and has certain limitations: Only one entity type per query (no JOIN) Maximum 100 results per query (use LIMIT and OFFSET to paginate) The WHERE, ORDER BY, and LIMIT clauses are optional The query...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/\" \/>\n<meta property=\"og:site_name\" content=\"Kafinea\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-requests-and-querying\\\/\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-requests-and-querying\\\/\",\"name\":\"Help - REST API - Requests and Querying &#8226; Kafinea\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#website\"},\"datePublished\":\"2026-04-03T00:43:18+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-requests-and-querying\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-requests-and-querying\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-requests-and-querying\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST API &#8211; Requests and Querying\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#website\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/\",\"name\":\"Kafinea\",\"description\":\"Une solution unique pour toutes vos ambitions\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#organization\",\"name\":\"Kafinea\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/wp-content\\\/uploads\\\/2024\\\/10\\\/Logo-Kafinea-SVG-orange-bleu.svg\",\"contentUrl\":\"https:\\\/\\\/www.kafinea.com\\\/wp-content\\\/uploads\\\/2024\\\/10\\\/Logo-Kafinea-SVG-orange-bleu.svg\",\"width\":296.31,\"height\":66.48,\"caption\":\"Kafinea\"},\"image\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.linkedin.com\\\/company\\\/kafinea\\\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Help - REST API - Requests and Querying &#8226; Kafinea","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/","og_locale":"en_US","og_type":"article","og_title":"Help - REST API - Requests and Querying &#8226; Kafinea","og_description":"Query \u2014 Querying the Database This operation allows you to perform a SELECT query. The query must follow a specific format and has certain limitations: Only one entity type per query (no JOIN) Maximum 100 results per query (use LIMIT and OFFSET to paginate) The WHERE, ORDER BY, and LIMIT clauses are optional The query...","og_url":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/","og_site_name":"Kafinea","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/","url":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/","name":"Help - REST API - Requests and Querying &#8226; Kafinea","isPartOf":{"@id":"https:\/\/www.kafinea.com\/en\/#website"},"datePublished":"2026-04-03T00:43:18+00:00","breadcrumb":{"@id":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-requests-and-querying\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.kafinea.com\/en\/"},{"@type":"ListItem","position":2,"name":"REST API &#8211; Requests and Querying"}]},{"@type":"WebSite","@id":"https:\/\/www.kafinea.com\/en\/#website","url":"https:\/\/www.kafinea.com\/en\/","name":"Kafinea","description":"Une solution unique pour toutes vos ambitions","publisher":{"@id":"https:\/\/www.kafinea.com\/en\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.kafinea.com\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.kafinea.com\/en\/#organization","name":"Kafinea","url":"https:\/\/www.kafinea.com\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.kafinea.com\/en\/#\/schema\/logo\/image\/","url":"https:\/\/www.kafinea.com\/wp-content\/uploads\/2024\/10\/Logo-Kafinea-SVG-orange-bleu.svg","contentUrl":"https:\/\/www.kafinea.com\/wp-content\/uploads\/2024\/10\/Logo-Kafinea-SVG-orange-bleu.svg","width":296.31,"height":66.48,"caption":"Kafinea"},"image":{"@id":"https:\/\/www.kafinea.com\/en\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/kafinea\/"]}]}},"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false},"uagb_author_info":{"display_name":"David Valminos","author_link":"https:\/\/www.kafinea.com\/en\/author\/david\/"},"uagb_comment_info":0,"uagb_excerpt":"Query \u2014 Querying the Database This operation allows you to perform a SELECT query. The query must follow a specific format and has certain limitations: Only one entity type per query (no JOIN) Maximum 100 results per query (use LIMIT and OFFSET to paginate) The WHERE, ORDER BY, and LIMIT clauses are optional The query...","_links":{"self":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/docs\/444465","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/comments?post=444465"}],"version-history":[{"count":0,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/docs\/444465\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/media?parent=444465"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/doc_category?post=444465"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/doc_tag?post=444465"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}