PageGoat Project Controller API
The project-controller API from PageGoat — 4 operation(s) for project-controller.
The project-controller API from PageGoat — 4 operation(s) for project-controller.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/pagegoat-com:pagegoat-com-project-controller-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Pagegoat Project Controller API
description: 'Programmatic access to Pagegoat sites. Authenticate with a Bearer access token: exchange your API key at `POST {IdP}/api/keys/token`, then send the returned JWT as `Authorization: Bearer `.'
version: 0.1.0
servers:
- url: https://api.pagegoat.com
description: Generated server url
security:
- bearer-jwt: []
tags:
- name: project-controller
paths:
/api/projects:
get:
tags:
- project-controller
summary: List every project visible to the caller
description: A project is visible if you own it or can access at least one of its member pages. Unpaginated — prefer `/api/projects/page`.
operationId: list_2
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/Project'
post:
tags:
- project-controller
summary: Create a project
description: 'Actor-gated: this consumes the CALLER''s plan, unlike acting on a site someone shared with them.'
operationId: create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNameRequest'
responses:
'402':
description: No paid plan, or the plan's project ceiling is already reached.
'201':
description: The created project.
content:
'*/*':
schema:
$ref: '#/components/schemas/Project'
/api/projects/{id}:
get:
tags:
- project-controller
summary: Project detail plus the member pages the caller can reach
operationId: get_1
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ProjectDetail'
delete:
tags:
- project-controller
summary: Delete a project
description: Owner only. Member pages are unfiled, never deleted.
operationId: delete_1
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: Deleted.
'404':
description: No such project.
'403':
description: Not the owner.
patch:
tags:
- project-controller
summary: Rename a project
description: Owner only.
operationId: update_1
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNameRequest'
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Project'
/api/projects/page:
get:
tags:
- project-controller
summary: One page of the caller's projects
operationId: page_1
parameters:
- name: limit
in: query
required: false
schema:
type: integer
format: int32
default: 12
- name: cursor
in: query
required: false
schema:
type: string
- name: q
in: query
required: false
schema:
type: string
- name: tab
in: query
required: false
schema:
type: string
default: all
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ProjectPage'
/api/projects/counts:
get:
tags:
- project-controller
summary: Totals for the caller's projects
operationId: counts_1
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ProjectCounts'
components:
schemas:
ProjectCounts:
required:
- groupedPages
- owned
- shared
- total
type: object
properties:
owned:
type: integer
format: int64
shared:
type: integer
format: int64
total:
type: integer
description: owned + shared.
format: int64
groupedPages:
type: integer
description: Pages the caller can reach that are filed under some project.
format: int64
description: How many projects the caller owns and can see.
ProjectMember:
required:
- name
- slug
- updatedAt
- visibility
type: object
properties:
slug:
type: string
name:
type: string
visibility:
type: string
enum:
- private
- password
- capture
- public
updatedAt:
type: string
format: date-time
description: A member page, summarised for a project card.
ProjectSite:
required:
- currentVersion
- name
- ownerSub
- role
- slug
- updatedAt
- visibility
type: object
properties:
slug:
type: string
name:
type: string
ownerSub:
type: string
role:
type: string
description: The caller's effective role on this page.
enum:
- viewer
- commenter
- admin
visibility:
type: string
enum:
- private
- password
- capture
- public
currentVersion:
type: integer
format: int32
updatedAt:
type: string
format: date-time
description: A member page, as listed on a project's detail page.
ProjectPage:
required:
- items
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ProjectCard'
nextCursor:
type:
- string
- 'null'
description: Opaque `<createdAt>|<id>` cursor. Null on the last page.
description: A page of projects plus the cursor for the next one.
ProjectCard:
required:
- collaborators
- commentCount
- createdAt
- id
- lastActivityAt
- memberCount
- name
- owned
- ownerSub
- recentSites
- siteCount
- updatedAt
type: object
properties:
id:
type: string
format: uuid
name:
type: string
ownerSub:
type: string
owned:
type: boolean
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
siteCount:
type: integer
description: Member pages the caller can access. The true total, so the card can say "+N more pages" beyond the few in `recentSites`.
format: int32
memberCount:
type: integer
format: int32
commentCount:
type: integer
description: Comments summed across every member page the caller can see.
format: int64
lastActivityAt:
type: string
description: Newest member page the caller can see, falling back to the project's own timestamp when they can see none.
format: date-time
collaborators:
type: array
description: Owner plus direct user grants across every visible member page, deduped and capped at 8.
items:
type: string
description: Owner plus direct user grants across every visible member page, deduped and capped at 8.
recentSites:
type: array
description: Up to 3 member pages, newest first.
items:
$ref: '#/components/schemas/ProjectMember'
description: A project plus the member data its card renders.
ProjectDetail:
required:
- createdAt
- id
- memberCount
- name
- owned
- ownerSub
- siteCount
- sites
- updatedAt
type: object
properties:
id:
type: string
format: uuid
name:
type: string
ownerSub:
type: string
owned:
type: boolean
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
siteCount:
type: integer
format: int32
memberCount:
type: integer
format: int32
sites:
type: array
items:
$ref: '#/components/schemas/ProjectSite'
description: A project and its accessible member pages.
ProjectNameRequest:
type: object
properties:
name:
type:
- string
- 'null'
description: Blank or omitted falls back to a generated default on create.
example: Q3 Launch
description: A project's name.
Project:
required:
- id
- memberCount
- name
- owned
- ownerSub
- siteCount
- updatedAt
type: object
properties:
id:
type: string
format: uuid
name:
type: string
example: Q3 Launch
ownerSub:
type: string
description: Token `sub` of the project owner.
owned:
type: boolean
description: True when the caller is that owner.
siteCount:
type: integer
description: Member pages the CALLER can access, not the project's total.
format: int32
example: 4
memberCount:
type: integer
description: 'Distinct people involved: the project owner plus every member page''s owner.'
format: int32
example: 2
updatedAt:
type: string
format: date-time
description: A project, as listed.
securitySchemes:
bearer-jwt:
type: http
scheme: bearer
bearerFormat: JWT