{"id":43495,"date":"2024-02-29T10:22:29","date_gmt":"2024-02-29T10:22:29","guid":{"rendered":"https:\/\/crocoblock.com\/knowledge-base\/?post_type=article&p=43495"},"modified":"2024-03-05T10:15:15","modified_gmt":"2024-03-05T10:15:15","slug":"configuring-rest-api-endpoint-for-custom-query","status":"publish","type":"article","link":"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/","title":{"rendered":"How to Configure the REST API Endpoint for Custom Query"},"content":{"rendered":"\n

REST API<\/strong><\/a> is a programming interface that allows you to create connections between your website and another website or app. With the Register Rest API Endpoint<\/a> <\/strong>option for the JetEngine<\/em> Query Builder<\/strong><\/a> <\/strong>feature, you can transfer the queried data.<\/p>\n\n\n\n

As an example, we will create a Custom Content Type query to transfer queried events to another WordPress website.<\/p>\n\n\n\n

Prepare a Custom Content Type on the Main Website<\/h2>\n\n\n\n
\n

On the main website, go to the WordPress Dashboard > JetEngine > <\/em><\/strong>JetEngine<\/em><\/strong><\/a> tab and make sure to enable the Custom Content Type <\/strong>toggle.<\/p>\n\n\n\n

\"enable<\/a><\/div>\n\n\n\n

Then, head to WordPress Dashboard > JetEngine > Custom Content Types <\/em><\/strong>and hit the \u201cAdd New<\/strong>\u201d button or click to edit the created CCT, which items you want to transfer.<\/p>\n\n\n\n

\"create<\/a><\/div>\n\n\n\n

Such settings are required in the General Settings<\/strong> section: enter the Name<\/strong>, and the Slug <\/strong>will be filled automatically from the Name<\/strong> field. You can change the Slug<\/strong> while creating the CCT, but use only Latin letters here and ensure no spaces: use hyphens or underscores instead.<\/p>\n\n\n\n

Other settings are optional for transferring the CCT items via REST API. Read more about them in the Custom Content Type (CCT) Overview<\/strong><\/a>.<\/p>\n\n\n\n

\"events<\/a><\/div>\n\n\n\n

In the Fields <\/strong>settings tab, we added the following meta fields: the Name \u201cText\u201d field, Date \u201cDate\u201d field, and Image \u201cMedia\u201d field.<\/p>\n\n\n\n

The \u201cMedia\u201d field requires more attention.<\/p>\n\n\n

<\/svg><\/div>
Warning<\/div>

If you choose the \"Media ID\" Value format<\/strong> and retrieve the image via the REST API, a conflict may arise if an image with the same ID already exists on the secondary website. So, we recommend setting the \u201cMedia URL\u201d Value format<\/strong>.<\/p><\/div><\/div>\n\n\n\n

\"media<\/a><\/div>\n\n\n\n

Adjust all desired settings to the CCT and press the \u201cAdd\/Update Content Type<\/strong>\u201d button.<\/p>\n\n\n\n

Then, proceed to the CCT menu tab on the WordPress Dashboard and create several CCT items by hitting the \u201cAdd New<\/strong>\u201d button and filling in the meta fields.<\/p>\n\n\n\n

\"cct<\/a><\/div>\n<\/div><\/div>\n\n\n\n

Create a Query on the Main Website<\/h2>\n\n\n\n
\n

Go to the WordPress Dashboard > JetEngine > Query Builder <\/em><\/strong>tab and hit the \u201cAdd New<\/strong>\u201d button.<\/p>\n\n\n\n

In the General Settings<\/a> <\/strong>section, enter the query Name<\/strong> and select the \u201cCustom Content Type Query<\/a>\u201d Query Type<\/strong>.\u00a0<\/p>\n\n\n\n

\"create<\/a><\/div>\n\n\n\n

Then, enable the Register Rest API Endpoint<\/strong> toggle to unfold a section with more settings for the endpoint registration.<\/p>\n\n\n\n

A detailed description of all options can be found in the Register Rest API Endpoint<\/a> <\/strong>chapter.<\/p>\n\n\n\n

You can set suitable Endpoint Namespace<\/strong> and Endpoint Path<\/strong> to improve SEO for your WordPress website.<\/p>\n\n\n\n

The Restrict Access<\/strong> for the endpoint can be set as well. You can configure the public access or entry only for users with certain roles or capacities.<\/p>\n\n\n\n

You can adjust the Query Arguments <\/strong>to customize the content returned by a web server. For instance, we entered a \u201csort\u201d QUERY ARGUMENT NAME <\/strong>and \u201casc\u201d DEFAULT VALUE<\/strong> to sort items (events) by date from the soonest to the latest.<\/p>\n\n\n\n

\"Register<\/a><\/div>\n\n\n\n

In the Content Types Query <\/strong>settings section, select the needed CCT from the From Content Type <\/strong>drop-down list.<\/p>\n\n\n\n

The registered arguments should be mapped to the query settings.<\/p>\n\n\n\n

In our case, we hit the \u201cAdd new sorting parameter<\/strong>\u201d button in the Order & Order By <\/strong>section. We set the Order By<\/strong> \u201cDate,\u201d the \u201cFrom lowest to highest (1, 2, 3; a, b, c)\u201d Order<\/strong>, and the \u201cDate\u201d Type<\/strong> to sort items (events) by date from the soonest to the latest.<\/p>\n\n\n\n

\"sorting<\/a><\/div>\n\n\n\n

Adjust other query settings according to your needs and hit the \u201cAdd\/Update Query<\/strong>\u201d button.<\/p>\n\n\n\n

Copy the Rest API Endpoint URL<\/strong> or Example of Rest API Endpoint URL with Query Arguments<\/strong> if you add query arguments to the endpoint.<\/p>\n\n\n\n

\"copy<\/a><\/div>\n<\/div><\/div>\n\n\n\n

Add the REST API Endpoint URL to the Second Website<\/h2>\n\n\n\n
\n

On the second website, follow the WordPress Dashboard > JetEngine > JetEngine <\/em><\/strong>path on the second website where you want to transfer the queried CCT items and turn on the Rest API Listings <\/strong>toggle. Press the \u201cSave<\/strong>\u201d button and wait until the page reloading is complete. <\/p>\n\n\n\n

\"Rest<\/a><\/div>\n\n\n\n

After that, the Rest API Endpoints <\/strong>tab will be available. Open it and click the \u201c+ New Endpoint<\/strong>\u201d button.<\/p>\n\n\n\n

Type the endpoint Name<\/strong> (optional), enter the copied URL into the API Endpoint URL<\/strong> field, the \u201c\/\u201d Items path<\/strong>, <\/strong>and set the Authorization <\/strong>if needed.<\/p>\n\n\n\n

All settings are described in the REST API Module<\/strong><\/a> chapter.<\/p>\n\n\n\n

Then, hit the \u201cSend Request<\/strong>\u201d button to send a sample request to check the API endpoint connection and fetch available fields. You will obtain the \u201cConnected\u201d Status<\/strong> if all progress without issue.<\/p>\n\n\n\n

Finally, push the \u201cSave<\/strong>\u201d button.<\/p>\n\n\n\n

\"adding<\/a><\/div>\n<\/div><\/div>\n\n\n\n

Create a Listing Template for the REST API Endpoint<\/h2>\n\n\n\n
\n

On the second website, head to WordPress Dashboard > <\/em><\/strong>JetEngine > Listings <\/em><\/strong>and hit the \u201cAdd New<\/strong>\u201d button.<\/p>\n\n\n\n

Select the \u201cREST API Endpoint\u201d Listing source<\/strong> and choose the recently added endpoint from the From API endpoint <\/strong>drop-down menu. Type the Listing item name <\/strong>(optional) and set one of the Listing views<\/strong> (it may be \u201cElementor,\u201d \u201cBlocks (Gutenberg),\u201d or \u201cBricks\u201d). For example, we chose the Elementor editor.<\/p>\n\n\n\n

Lastly, hit the \u201cCreate Listing Item<\/strong>\u201d button.<\/p>\n\n\n\n

\"setup<\/a><\/div>\n\n\n\n

On the editing page, place the Dynamic Field<\/strong><\/a> <\/strong>widget. Keep the \u201cPost\/Term\/User\/Object Data\u201d Source<\/strong>. In the Object Field<\/strong> drop-down menu, <\/strong>scroll down to the REST API <\/strong>section and select the needed meta field which data you want to display.<\/p>\n\n\n\n

First, we picked the \u201cname\u201d meta field.<\/p>\n\n\n\n

\"REST<\/figure>\n\n\n\n

Then, we duplicated the widget and chose the \u201cdate\u201d meta field. For the \u201cDate\u201d meta field types, you can enable the Filter field output <\/strong>toggle and pick the \u201cFormat date\u201d Callback<\/strong> to customize the date format.<\/p>\n\n\n\n

Read about the Customizing the Time and Date Format<\/strong><\/a>.<\/p>\n\n\n\n

Learn more about the Dynamic Field Callbacks<\/strong><\/a>.<\/p>\n\n\n\n

\"format<\/a><\/div>\n\n\n\n

The image can be displayed in two ways. The first is to place the Dynamic Image<\/strong><\/a> widget and pick the needed \u201cMedia\u201d meta field (\u201cimage,\u201d in our case) from the REST API <\/strong>section as the Source<\/strong>.<\/p>\n\n\n\n

\"dynamic<\/a><\/div>\n\n\n\n

As the second way, for the Dynamic Field <\/strong>widget, we picked the \u201cimage\u201d meta field, enabled the Customize field output<\/strong> toggle, and entered \u201c<img src=\u2018%s\u2019\/>\u201d into the Field format <\/strong>textarea.<\/p>\n\n\n\n

\"customize<\/a><\/div>\n\n\n\n

Adjust other Listing template<\/strong><\/a> settings and hit the \u201cUpdate<\/strong>\u201d button.<\/p>\n<\/div><\/div>\n\n\n\n

Check the Result<\/h2>\n\n\n\n
\n

To place the listing, open the needed page in the Elementor, WordPress block, or Bricks editor, place the Listing Grid<\/strong> there, and pick the recently created LISTING<\/strong> from the drop-down menu.<\/p>\n\n\n\n

The events in our Listing Grid<\/strong><\/a> block are displayed in ascending order by dates.<\/p>\n\n\n\n

Configure the page and Listing Grid<\/strong> settings and hit the \u201cPublish\/Update<\/strong>\u201d button.<\/p>\n\n\n\n

\"listing<\/a><\/div>\n<\/div><\/div>\n\n\n\n

That\u2019s all. Now you know how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine<\/em> WordPress plugin.<\/p>\n","protected":false},"excerpt":{"rendered":"

From this tutorial, you will learn how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine WordPress plugin.<\/p>\n","protected":false},"author":8,"featured_media":0,"template":"","format":"standard","builder-category":[],"article-category":[407],"yoast_head":"\nHow to Configure the REST API Endpoint for Custom Query \u2013 JetEngine | Crocoblock<\/title>\n<meta name=\"description\" content=\"From this tutorial, you will learn how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine WordPress plugin.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to Configure the REST API Endpoint for Custom Query \u2013 JetEngine | Crocoblock\" \/>\n<meta property=\"og:description\" content=\"From this tutorial, you will learn how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine WordPress plugin.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/\" \/>\n<meta property=\"og:site_name\" content=\"Help Center\" \/>\n<meta property=\"article:modified_time\" content=\"2024-03-05T10:15:15+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/crocoblock.com\/knowledge-base\/wp-content\/uploads\/2024\/02\/enable-the-custom-content-type-module.webp\" \/>\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=\"9 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/\",\"url\":\"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/\",\"name\":\"How to Configure the REST API Endpoint for Custom Query \u2013 JetEngine | Crocoblock\",\"isPartOf\":{\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/#website\"},\"datePublished\":\"2024-02-29T10:22:29+00:00\",\"dateModified\":\"2024-03-05T10:15:15+00:00\",\"description\":\"From this tutorial, you will learn how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine WordPress plugin.\",\"breadcrumb\":{\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/crocoblock.com\/knowledge-base\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Articles\",\"item\":\"https:\/\/crocoblock.com\/knowledge-base\/articles\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"How to Configure the REST API Endpoint for Custom Query\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/#website\",\"url\":\"https:\/\/crocoblock.com\/knowledge-base\/\",\"name\":\"Help Center\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/crocoblock.com\/knowledge-base\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/#organization\",\"name\":\"Help Center\",\"url\":\"https:\/\/crocoblock.com\/knowledge-base\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/crocoblock.com\/knowledge-base\/wp-content\/uploads\/2025\/04\/invert-crocoblock-logo.svg\",\"contentUrl\":\"https:\/\/crocoblock.com\/knowledge-base\/wp-content\/uploads\/2025\/04\/invert-crocoblock-logo.svg\",\"caption\":\"Help Center\"},\"image\":{\"@id\":\"https:\/\/crocoblock.com\/knowledge-base\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to Configure the REST API Endpoint for Custom Query \u2013 JetEngine | Crocoblock","description":"From this tutorial, you will learn how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine WordPress plugin.","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:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/","og_locale":"en_US","og_type":"article","og_title":"How to Configure the REST API Endpoint for Custom Query \u2013 JetEngine | Crocoblock","og_description":"From this tutorial, you will learn how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine WordPress plugin.","og_url":"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/","og_site_name":"Help Center","article_modified_time":"2024-03-05T10:15:15+00:00","og_image":[{"url":"https:\/\/crocoblock.com\/knowledge-base\/wp-content\/uploads\/2024\/02\/enable-the-custom-content-type-module.webp"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"9 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/","url":"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/","name":"How to Configure the REST API Endpoint for Custom Query \u2013 JetEngine | Crocoblock","isPartOf":{"@id":"https:\/\/crocoblock.com\/knowledge-base\/#website"},"datePublished":"2024-02-29T10:22:29+00:00","dateModified":"2024-03-05T10:15:15+00:00","description":"From this tutorial, you will learn how to configure the REST API endpoint for custom queries and how to transfer the queried CCT items from one website to another with the JetEngine WordPress plugin.","breadcrumb":{"@id":"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/crocoblock.com\/knowledge-base\/jetengine\/configuring-rest-api-endpoint-for-custom-query\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/crocoblock.com\/knowledge-base\/"},{"@type":"ListItem","position":2,"name":"Articles","item":"https:\/\/crocoblock.com\/knowledge-base\/articles\/"},{"@type":"ListItem","position":3,"name":"How to Configure the REST API Endpoint for Custom Query"}]},{"@type":"WebSite","@id":"https:\/\/crocoblock.com\/knowledge-base\/#website","url":"https:\/\/crocoblock.com\/knowledge-base\/","name":"Help Center","description":"","publisher":{"@id":"https:\/\/crocoblock.com\/knowledge-base\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/crocoblock.com\/knowledge-base\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/crocoblock.com\/knowledge-base\/#organization","name":"Help Center","url":"https:\/\/crocoblock.com\/knowledge-base\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/crocoblock.com\/knowledge-base\/#\/schema\/logo\/image\/","url":"https:\/\/crocoblock.com\/knowledge-base\/wp-content\/uploads\/2025\/04\/invert-crocoblock-logo.svg","contentUrl":"https:\/\/crocoblock.com\/knowledge-base\/wp-content\/uploads\/2025\/04\/invert-crocoblock-logo.svg","caption":"Help Center"},"image":{"@id":"https:\/\/crocoblock.com\/knowledge-base\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/crocoblock.com\/knowledge-base\/wp-json\/wp\/v2\/article\/43495"}],"collection":[{"href":"https:\/\/crocoblock.com\/knowledge-base\/wp-json\/wp\/v2\/article"}],"about":[{"href":"https:\/\/crocoblock.com\/knowledge-base\/wp-json\/wp\/v2\/types\/article"}],"author":[{"embeddable":true,"href":"https:\/\/crocoblock.com\/knowledge-base\/wp-json\/wp\/v2\/users\/8"}],"wp:attachment":[{"href":"https:\/\/crocoblock.com\/knowledge-base\/wp-json\/wp\/v2\/media?parent=43495"}],"wp:term":[{"taxonomy":"builder-category","embeddable":true,"href":"https:\/\/crocoblock.com\/knowledge-base\/wp-json\/wp\/v2\/builder-category?post=43495"},{"taxonomy":"article-category","embeddable":true,"href":"https:\/\/crocoblock.com\/knowledge-base\/wp-json\/wp\/v2\/article-category?post=43495"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}