APIActive

Payload REST API

Automatically generated RESTful HTTP API for interacting with Payload documents.

Open source page ↗

Field note

What it does

A fully functional REST API generated from Collection and Global configs, supporting CRUD, pagination, depth, sorting and auth operations.

Capabilities

Available capabilities

Relationship Depth Control Auto-generated API Automatic Pagination CRUD Operations Multi-locale Support Authentication Endpoints Sorting Authentication Pagination

Tags

Tags

Ways to use it

Ways to use it

sdk

typescript / payload

sdk

Not filed / Not filed

Product features

Product features

Auth Operations

Collections

Custom Endpoints

Add custom REST endpoints at config, collection or global level.

Example

Globals

Globals Endpoints

Get and update global documents via REST endpoints.

Helpful tips

How to Use

Method Override for GET Requests

Preferences

Preferences Endpoints

Manage admin user preferences via REST endpoints.

Query Parameters

Supports depth, locale, select, limit, page, sort, where and joins.

REST API

Root-level routes

Using Method Override (POST)