Skip to content

Page tools

Three tools for the pages a project tracks.

List pages in a project, optionally filtered by URL.

NameTypeRequiredNotes
project_idstringyes
url_filterstringnoPartial match against the page URL.
firstnumbernoPage size. Default 20.
afterstringnoOpaque cursor from a prior page’s endCursor.

Returns: { totalCount, pageInfo, pages }.

Returns an error block if your credential cannot reach that project.

Add a page to a project.

NameTypeRequiredNotes
project_idstringyes
organization_idstringyes
urlstringyese.g. https://example.com/about.
descriptionstringno

Returns: the created page.

To add many pages at once, use import_sitemap instead.

Delete a page from a project. Requires the admin role.

NameTypeRequired
page_idstringyes
organization_idstringyes

Returns: the confirmation line Deleted page: <url>.