Payload SDK

Type-safe client for the Payload REST API with CRUD, auth and file uploads

Official 45,915 61.2k/wk MIT v3.94.0

Installation

pnpm add @payloadcms/sdk

About

Payload SDK is a typed client for calling the Payload REST API from JavaScript or TypeScript code running in a frontend, a script or another backend. Passing your generated Payload types into the client gives you autocomplete and type checking for collection slugs, fields, select, populate and joins. It covers reading, creating, updating and deleting documents, globals, versions and restores, plus login, password reset and the current user lookup.

Uploads take a File, a Blob or a URL string in the same call that creates the media document, so you do not need to build multipart requests by hand. Per-request options such as headers or credentials can be set on each call or shared across the whole client. Custom endpoints can be reached through the same client.

Package info

Package name
@payloadcms/sdk
Latest version
3.94.0
Unpacked size
182 kB
License
MIT
Weekly downloads
61.2k
Last publish
Nov 17, 2026

More from payloadcms

View profile

Stores Payload upload files in Cloudflare R2 buckets instead of local disk

Adds a parent field and breadcrumbs to collections so documents can nest inside each other

Sends Payload server errors and selected HTTP errors to Sentry with user context

Adds an SEO tab with meta title, description, image and search preview to collections

Stores collection uploads in Vercel Blob Storage instead of local disk

Lets one Payload admin panel manage content for many separate tenants

Framework-agnostic SDK for inline visual editing on Payload-powered sites

Angular query builder that sends list queries to Payload and other backends as signals

Registers custom drag-and-drop blocks for the Olgax page builder

Lets Puck components pull filtered Payload collection items into a resolved prop

Signed client for the VAP API, plus a Payload plugin for storefront sign-in and checkout

Typed custom operations for Payload with a client and server-side contract