Payload CMS GraphQL API
Payload CMS ships a fully featured GraphQL API generated automatically from your collection and global configurations. Every collection defined in your Payload config produces a set of strongly-typed queries and mutations — find by ID, find (paginated), count, create, update, delete, duplicate, and version operations — all derived from the collection slug and its field definitions. Auth-enabled collections additionally receive login, logout, refresh, me, forgotPassword, resetPassword, verifyEmail, unlock, and initialized operations. Globals receive a findOne query and an update mutation. The schema is built at startup using `@payloadcms/graphql`'s `configToSchema()` function, and the resulting SDL can be exported with `pnpm payload-graphql generate:schema`.
Overview
Payload CMS GraphQL API is a GraphQL API specification published by Payload CMS on the APIs.io network.
Payload CMS ships a fully featured GraphQL API generated automatically from your collection and global configurations. Every collection defined in your Payload config produces a set of strongly-typed queries and mutations — find by ID, find (paginated), count, create, update, delete, duplicate, and version operations — all derived from the collection slug and its field definitions. Auth-enabled collections additionally receive login, logout, refresh, me, forgotPassword, resetPassword, verifyEmail, unlock, and initialized operations. Globals receive a findOne query and an update mutation. The schema is built at startup using @payloadcms/graphql’s configToSchema() function, and the resulting SDL can be exported with pnpm payload-graphql generate:schema.
The GraphQL endpoint is available at https://{your-domain}/api/graphql. documentation is published at https://payloadcms.com/docs/graphql/overview.
The specification includes 4 reference links.
Tagged areas include Headless CMS, Content Management, REST API, Next.js, and Open Source.
Endpoint
References
- Documentation https://payloadcms.com/docs/graphql/overview
- Schema Generation https://payloadcms.com/docs/graphql/graphql-schema
- Extending GraphQL https://payloadcms.com/docs/graphql/extending
- GettingStarted https://payloadcms.com/docs/getting-started/what-is-payload