Skip to content
  • Why WPGetAPI?
  • Examples
  • Pricing
  • Plugins
    • PRO Plugin
    • API to Posts Plugin
    • OAuth 2.0 Plugin
  • Docs
  • Support
    • Frequently Asked Questions
    • Feature Request
    • Support Ticket
  • account_circle
PRO Plugin
Howdy! How can we help you?
  • Introduction

    • Quick Start
    • Frequently Asked Questions
    • Will this work with my API?
    • Understanding API docs
    • Step by Step Example
  • Setup

    • Setup Page
    • Endpoint Page
    • Parameters - Query String
    • Parameters - Headers
    • Parameters - Body POST
    • Shortcode
    • Template Tag
    • Gutenberg Block
  • Connecting your API

    • API Key in Headers
    • API Key in Query String
    • Authentication & Authorization
  • Output API Data

    • Format API to HTML
    • Format API to HTML Table
    • Format API to Image Gallery
    • Format JSON Data
  • Integrations

    • Send form data to API
    • WPForms to API
    • Gravity Forms to API
    • Contact Form 7 to API
    • WooCommerce to API
    • WooCommerce API Product Sync
    • wpDataTables to API
    • Connect WordPress to OpenAI
    • Connect RapidAPI to WordPress
    • Connect Zoho CRM to WordPress
    • Page Builders (Elementor, DIVI)
    • Formidable Forms to API
    • Elementor Form to API
    • JetFormBuilder to API
    • Fluent Forms to API
    • WS Form to API
    • Ninja Tables to API
    • Easy Digital Downloads(EDD) API Product Sync
    • Ultimate Member Forms to API
  • Tips & Tricks

    • Filters & Action Hooks
    • Code Snippets Plugin
    • Troubleshooting
    • Code Snippets
  • PRO Plugin

    • Installation
    • Actions
    • Tokens
    • Caching
    • Nested data
    • Chaining API calls
    • Dynamic Variables
    • Format API to HTML
    • Call API on user registration
    • Using AJAX to trigger API call
    • Base64 Encoding
    • Licensing
    • Filters & Action Hooks
  • OAuth 2.0 Plugin

    • Installation
    • How it works
    • Grant Type - Client Credentials
    • Grant Type - Authorization Code
    • Licensing
  • API to Posts Plugin

    • Installation
    • Getting Started
    • Multiple Endpoints
    • Mapping Fields
    • Filters & Action Hooks
    • Pagination

After adding an API to the Setup Page, you will see that the API now gets its own tab – clicking on the tab will take us to the Endpoint Page as shown below.

Along with the fields for configuring the endpoint, we can see that this page shows the Base URL that we set up in the Setup page. It also shows the Test Endpoint button as well as the Template Tag and Shortcode that can be used for each endpoint to display or send data.

You can add unlimited endpoints within the endpoint page, simply by clicking the Add Endpoint button.

Let’s look what each field does within the endpoint page.


Unique ID field

The Unique ID field is used to identify an endpoint within the shortcode or the template tag. If you are using multiple different endpoints, then you must ensure this is unique.

It is usually a good idea for the Unique ID to be the same (or similar) name as the endpoint.

In the example below, the endpoint is ‘/v1/random’ so we have set the Unique ID as random.

We can also see how this Unique ID is used within the shortcode and template tag. It is used to identify the endpoint.


Endpoint field

The Endpoint field is used to add the endpoint. This endpoint will be appended to the Base URL to create a complete URL that will be called when using this endpoint. You can find the endpoint details within your API’s documentation.

This field should begin with a /


Method field

The Method field is a drop down with the following options: GET, POST, PUT, PATCH, DELETE

This is used to set the desired request method for your API call. You can find this within your API docs, but as a general rule you would use a GET request to display data from an API and you would use the other methods to send data to the API.


Results Format field

The Results Format field determines the output of the API data and there are 2 options: PHP array data or JSON string

The format you choose will largely depend on how you are going to use the returned data.

JSON string

When set to JSON string, the output will look something like the below.

PHP array data

When set to PHP array data, the output will look something like the below.

As a rule of thumb, set this to JSON string when you are using the shortcode and set to PHP array data when using the template tag.


Query String fields

You can add unlimited query string parameters using the Query String name/value fields.

We have a detailed article on these fields here: https://wpgetapi.com/docs/adding-query-string-parameters/


Headers fields

You can add unlimited header parameters using the Headers name/value fields.

We have a detailed article on these fields here: https://wpgetapi.com/docs/sending-headers-in-request/


Body POST fields

You can add unlimited body POST parameters using the Body POST name/value fields. This field does not work with GET requests.

We have a detailed article on these fields here: https://wpgetapi.com/docs/sending-post-fields-in-request/


Encode Body field

The Encode Body field is only used when you have data within the Body POST fields and the Request Method is set to POST, PUT, PATCH or DELETE.

You will need to choose the option that your API says to use in their API documentation. If your API docs do not mention the type, you can experiment to see which one will work.

The options for this field are:

  • No encoding (raw)
  • JSON encode
  • URL encode (x-www-form-urlencoded)
  • Base64 encode
  • XML format (available in PRO Plugin only)

Next Steps

With the API and the endpoint setup, you will now want to use the template tag or the shortcode to call your API from the front end.

On this page
contact_support

Still not sure?

APIs can be daunting and sometimes downright confusing.

But we are here to help! Our support is amazing and we can assist you with any setup required and ensure your API integrations are a success!

Ask Us Anything

Connect your WordPress website to external APIs without writing a single line of code. Send data from WordPress to your API or display data from your API within WordPress.

Support

  • Documentation
  • Support Ticket
  • Refund Policy
  • Contact Us
  • About Us
  • Affiliates

Articles

  • Quick Start Guide
  • WooCommerce Orders to API
  • WooCommerce API Products Sync
  • Contact Form 7 to API
  • WPForms to API
  • Gravity Forms to API
  • WordPress to RapidAPI

WordPress API Plugins

  • Free WPGetAPI Plugin
  • PRO Plugin
  • API to Posts Plugin Plugin
  • OAuth 2.0 Authorization Plugin

© 2025 WPGetAPI. All Rights Reserved.

"*" indicates required fields

Name*
This field is for validation purposes and should be left unchanged.