Wiki API available queries

The query type defines the operations you can use to retrieve wiki content.

`list`

Fetch a list of articles with filter and pagination options.

Arguments

Name	Type	Required	Description
`limit`	Int	No	Maximum number of pages to return.
`offset`	Int	No	Number of items to skip (pagination).
`orderBy`	PageOrderBy	No	Field to sort by. Possible values: `CREATED`, `ID`, `PATH`, `TITLE`, `UPDATED`.
`orderByDirection`	PageOrderByDirection	No	Sort direction. Possible values: `ASC`, `DESC`.
`tags`	[String!]	No	Filter pages by tags. Matches any tag by default, or all tags when `isTagsLogicAnd` is `true`.
`isTagsLogicAnd`	Boolean	No	When `true`, tags filter uses AND logic, otherwise OR logic.
`ids`	[String!]	No	Restrict results to the specified page IDs.
`search`	String	No	Search term to match in page metadata or content.
`publicationState`	Boolean	No	Filter by publication status. `true` = published, `false` = unpublished.
`count`	Boolean	No	When `true`, only the `totalCount` is returned. Items may be omitted based on permissions.

`single`

Fetch a single article and its details.

Return type: Page

Arguments

Name	Type	Required	Description
`id`	Int!	Yes	ID of the page to retrieve.

Types

GraphQL types describe the structure of the data returned by queries. They define the fields available on each resource and the format of their values.

PageListResult

The response of a call to the list endpoint.

Fields

Name	Type	Description
`items`	[PageListItem]	List of pages returned for the current query or filters.
`totalCount`	Int	Total number of matching pages across all pages in the database.

PageTag

A tag associated with pages

Fields

Name	Type	Nullable	Description
`id`	Int!	No	Unique identifier of the tag.
`tag`	String!	No	Machine-readable tag value (slug).
`title`	String	Yes	Human-friendly display name of the tag.

PageListItem

A wiki article representation returned in a list query.

Fields

Name	Type	Nullable	Description
`id`	Int!	No	Unique identifier of the page.
`path`	String!	No	Canonical path (slug) of the page.
`locale`	String!	No	Locale code of the page (for example, `en`).
`title`	String	Yes	Title of the page.
`description`	String	Yes	Summary or short description.
`contentType`	String!	No	Content type (for example, `markdown`, `html`).
`isPublished`	Boolean!	No	Whether the page is published.
`isPrivate`	Boolean!	No	Whether the page is private.
`preventScraping`	Boolean!	No	Whether scraping of this page is disabled.
`privateNS`	String	Yes	Private namespace identifier.

Page

A full representation of a wiki article.

Fields

Name	Type	Nullable	Description
`id`	Int!	No	Unique identifier of the page.
`path`	String!	No	Canonical path (slug) of the page.
`title`	String!	No	Title of the page.
`description`	String!	No	Short description or summary of the page.
`isPrivate`	Boolean!	No	Whether the page is private.
`isPublished`	Boolean!	No	Whether the page is published.
`preventScraping`	Boolean!	No	Whether scraping is disabled for this page.
`privateNS`	String	Yes	Private namespace identifier.
`publishStartDate`	Date!	No	Publishing start timestamp.
`publishEndDate`	Date!	No	Publishing end timestamp.
`tags`	[PageTag]!	No	Tags associated with the page.
`render`	String	No	Server-rendered HTML content. Use this to display in frontend.
`scriptCss`	String	Yes	Custom CSS required by the article.
`scriptJs`	String	Yes	Custom JavaScript required by the article.
`contentType`	String!	No	Content type (for example, `markdown`, `html`).
`createdAt`	Date!	No	Creation timestamp.
`updatedAt`	Date!	No	Last update timestamp.
`locale`	String!	No	Locale code (for example, `en`).
`authorId`	Int!	No	ID of the author or last editor.
`authorName`	String!	No	Name of the author or last editor.
`authorEmail`	String!	No	Email of the author or last editor.
`creatorId`	Int!	No	ID of the creator.
`creatorName`	String!	No	Name of the creator.
`creatorEmail`	String!	No	Email of the creator.

Enums

Enums define the possible sets of values for a field.

PageOrderBy

Field that can be used to order the results of list.

Values

ID: Page ID (sequential integer).
PATH: Page path.
TITLE: Page title.
UPDATED: Last update date.
CREATED: Creation date.

PageOrderByDirection

Direction to sort the list results.

Values

ASC: Ascending order.
DESC: Descending order.