Pods REST API Endpoints - Pods Docs

The new REST API endpoints are shown below, relative to the root of your WP REST API path, for example /wp-json/ is the default.

Each endpoint supports GET (for getting data), POST (for adding an item, or updating, depending on the endpoint), and DELETE (for deleting an item).

Contents

REST API Information
Pod Configurations
Group Configurations
Field Configurations

REST API Information

/pods/v1 [GET]
/pods/v1/doc [GET]

Pod Configurations

/pods/v1/pods [GET, POST]
/pods/v1/pods/(?P<id>\d+) [GET, POST, DELETE]
/pods/v1/pods/(?P<slug>[\w\_\-]+) [GET, POST, DELETE]

Group Configurations

/pods/v1/groups [GET, POST]
/pods/v1/groups/(?P<id>\d+) [GET, POST, DELETE]
/pods/v1/pods/(?P<pod>[\w\_\-]+)/groups/(?P<slug>[\w\_\-]+) [GET, POST, DELETE]

Field Configurations

/pods/v1/fields [GET, POST]
/pods/v1/fields/(?P<id>\d+) [GET, POST, DELETE]
/pods/v1/pods/(?P<pod>[\w\_\-]+)/fields/(?P<slug>[\w\_\-]+) [GET, POST, DELETE]

Other Helpful Documentation on Code Reference

Action Hook Reference

Field Functions

Field handling with Pods

Filter Reference

General Functions

Media Functions

Media handling functions in Pods

Pods Blocks API

Pods 2.8 introduces a new API for creating blocks with PHP.

Pods DFV JS API

The DFV JS API allows you to interact with the forms that Pods displays.

Pods WP-CLI Commands

How to use the Pods CLI to access wp pods and wp pods api

pods_api()

We are working hard on our new code reference site. Until then this section will remain unavailable. Thank you for your patience.

pods_ui()

Easily create content admin screens with in-depth customization.

pods()

Set up the Pods class object for a specific pod.

Registering Configurations

Registering Configurations with Pods is possible through file-based or code-based registration.

WPGraphQL Integration

The WPGraphQL integration allows Pods content types and their fields to be discoverable by the WPGraphQL plugin.