GraphQL API - Plume

Every content type generates a set of GraphQL fields at /graphql. For a type with apiId article, you get the operations below. An interactive explorer is available at /graphql in a browser.

Generated operations

For article:

Operation	Kind	Purpose
`article(id, status)`	query	Fetch one entry by id.
`articles(where, sort, limit, offset, status)`	query	List entries.
`articlesCount(where, status)`	query	Count matching entries.
`createArticle(data)`	mutation	Create a draft.
`updateArticle(id, data)`	mutation	Patch an entry.
`deleteArticle(id)`	mutation	Delete an entry.
`publishArticle(id)`	mutation	Publish.
`unpublishArticle(id)`	mutation	Return to draft.

Filtering

Each field exposes operators matching its type. Combine them in the where argument.

{
  articles(
    where: { category: { eq: "news" }, views: { gte: 100 } }
    sort: ["views_DESC"]
    limit: 10
  ) {
    id
    title
    writer { fullName }
  }
  articlesCount(where: { category: { eq: "news" } })
}

Operator	Applies to
`eq`, `ne`	all fields (use `eq: null` for missing values)
`in`	all fields (max 80 values)
`contains`	string fields
`gt`, `gte`, `lt`, `lte`	numbers and strings

Sort keys are fieldName_ASC or fieldName_DESC, including the built-in createdAt, updatedAt, and publishedAt. limit defaults to 50 and caps at 200.

Draft and publish

New entries are drafts. The status argument accepts DRAFT, PUBLISHED, or ALL, but it is only honored for authenticated users and write keys — anonymous and read-key callers always see published entries only.

mutation {
  publishArticle(id: "…") { status publishedAt }
}

Relations resolve inline

Relation fields resolve to the related entry type. A related entry that is still a draft is hidden from callers who cannot see drafts, and relations into a non-public type are hidden from anonymous callers.

{
  article(id: "…") {
    title
    writer { fullName }
    related { title slug }
  }
}

Query depth is capped at 12 levels to prevent expensive cyclic-relation queries.

​Generated operations

​Filtering

​Draft and publish

​Relations resolve inline

Generated operations

Filtering

Draft and publish

Relations resolve inline