Payload CMS
Read and manage content in a Payload CMS deployment through its REST and GraphQL APIs.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| Payload JWT | api_key | available | — |
Call a tool
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "PAYLOAD_CMS_GRAPHQL_EXECUTE", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("PAYLOAD_CMS_GRAPHQL_EXECUTE", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute PAYLOAD_CMS_GRAPHQL_EXECUTE --data '{ }'Tool catalog
Available tools
10 callable operations
Run Payload CMS GraphQL query or mutationPAYLOAD_CMS_GRAPHQL_EXECUTEExecutes an arbitrary GraphQL query or mutation against Payload CMS's API using the connected account. Use this escape hatch when reviewed tools do not cover the needed operation.Connection2 scopes
Executes an arbitrary GraphQL query or mutation against Payload CMS's API using the connected account. Use this escape hatch when reviewed tools do not cover the needed operation.
Authentication
Connected account requiredScopes
readwriteTags
Check Payload GraphQL endpointPAYLOAD_GRAPHQL_HEALTHChecks that the configured Payload GraphQL endpoint accepts a schema-independent query.Connection1 scope
Checks that the configured Payload GraphQL endpoint accepts a schema-independent query.
Authentication
Connected account requiredScopes
readTags
Count Payload collection documentsPAYLOAD_REST_COLLECTIONS_COUNTCounts documents visible in a Payload collection.Connection1 scope
Counts documents visible in a Payload collection.
Authentication
Connected account requiredScopes
readTags
Create a Payload collection documentPAYLOAD_REST_COLLECTIONS_CREATECreates one document in a Payload collection using fields accepted by the connected project schema.Connection1 scope
Creates one document in a Payload collection using fields accepted by the connected project schema.
Authentication
Connected account requiredScopes
writeTags
Delete a Payload document by IDPAYLOAD_REST_COLLECTIONS_DELETE_BY_IDDeletes one Payload collection document by ID.Connection1 scope
Deletes one Payload collection document by ID.
Authentication
Connected account requiredScopes
writeTags
Find Payload collection documentsPAYLOAD_REST_COLLECTIONS_FINDLists documents from a Payload collection. The collection slug and available fields come from the connected project.Connection1 scope
Lists documents from a Payload collection. The collection slug and available fields come from the connected project.
Authentication
Connected account requiredScopes
readTags
Find a Payload document by IDPAYLOAD_REST_COLLECTIONS_FIND_BY_IDRetrieves one document from a Payload collection by ID.Connection1 scope
Retrieves one document from a Payload collection by ID.
Authentication
Connected account requiredScopes
readTags
Update a Payload document by IDPAYLOAD_REST_COLLECTIONS_UPDATE_BY_IDUpdates one Payload collection document by ID using fields accepted by the connected project schema.Connection1 scope
Updates one Payload collection document by ID using fields accepted by the connected project schema.
Authentication
Connected account requiredScopes
writeTags
Get a Payload globalPAYLOAD_REST_GLOBALS_GETRetrieves a Payload global by its project-defined slug.Connection1 scope
Retrieves a Payload global by its project-defined slug.
Authentication
Connected account requiredScopes
readTags
Update a Payload globalPAYLOAD_REST_GLOBALS_UPDATEUpdates a Payload global using fields accepted by the connected project schema.Connection1 scope
Updates a Payload global using fields accepted by the connected project schema.
Authentication
Connected account requiredScopes
writeTags