PageGoat Free Link Claim Controller API

The free-link-claim-controller API from PageGoat — 1 operation(s) for free-link-claim-controller.

GitHub OpenAPI

Operations 1

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/pagegoat-com:pagegoat-com-free-link-claim-controller-api"
All apis
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.

Get an API 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 Specification

pagegoat-com-free-link-claim-controller-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Pagegoat Free Link Claim 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: free-link-claim-controller
paths:
  /api/free-links/{slug}/claim:
    post:
      tags:
      - free-link-claim-controller
      summary: Keep a free link
      description: Moves a free link into the caller's account at the same address. It stops expiring and becomes an ordinary site. Needs the claim token the link was made with, and a plan that can take one more site.
      operationId: claimFreeLink
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimFreeLinkRequest'
      responses:
        '402':
          description: No paid plan, the site cap, or the storage quota.
        '451':
          description: Suspended.
        '200':
          description: The site, now the caller's.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Site'
        '409':
          description: Already kept.
        '404':
          description: No such free link, it expired, or the token is wrong.
components:
  schemas:
    Site:
      required:
      - captureOtp
      - captureReverifyDays
      - commentsEnabled
      - currentVersion
      - freeLink
      - hiddenFromSearch
      - name
      - passwordSet
      - reason
      - role
      - slug
      - updatedAt
      - visibility
      - visitorCount
      type: object
      properties:
        slug:
          type: string
          description: URL-safe identifier; the site's public path.
          example: myfirstproject-11
        name:
          type: string
          description: Display name.
          example: My First Project
        role:
          type: string
          description: The caller's effective role on this site.
          example: admin
          enum:
          - viewer
          - commenter
          - admin
        reason:
          type: string
          description: Why the caller has that role — ownership, a grant, or public access.
          example: owner
        commentsEnabled:
          type: boolean
          description: Whether new comments may be created.
          example: true
        visibility:
          type: string
          description: Link-access mode. `password` means a visitor must enter the site's password before anything is served; `capture` means they must confirm an email address.
          example: public
          enum:
          - private
          - password
          - capture
          - public
        publicRole:
          type:
          - string
          - 'null'
          description: Role granted to anyone who gets in via the link — public, or password or capture once cleared.
          enum:
          - viewer
          - commenter
          - null
        passwordSet:
          type: boolean
          description: Whether a link password is set. The password itself is never returned.
          example: false
        hiddenFromSearch:
          type: boolean
          description: Advisory `noindex` on the viewer page. NOT access control.
          example: false
        captureOtp:
          type: boolean
          description: 'Capture mode: whether visitors must confirm a six-digit code.'
          example: true
        captureReverifyDays:
          type: integer
          description: 'Capture mode: days a confirmed visitor stays confirmed; 0 means every visit.'
          format: int32
          example: 30
        captureDomains:
          type:
          - string
          - 'null'
          description: 'Capture mode: comma-separated domains the gate accepts, or null for any.'
          example: acme.com,northloop.co
        visitorCount:
          type: integer
          description: Addresses captured on this site, ever. The Visitors tab exists for as long as this is above zero, whatever the current mode.
          format: int64
          example: 128
        currentVersion:
          type: integer
          description: Version currently served. Incremented by each re-upload.
          format: int32
          example: 2
        format:
          type:
          - string
          - 'null'
          description: 'What the current version was uploaded as: `html`, `zip`, `md` (Markdown, rendered to a page), `txt` (plain text, rendered to a page) or `pdf` (shown in pagegoat''s PDF viewer). Null for a site uploaded before formats were recorded, which is HTML or a ZIP.'
          example: md
          enum:
          - html
          - zip
          - md
          - txt
          - pdf
          - null
        sourceName:
          type:
          - string
          - 'null'
          description: 'The uploaded file''s own name, for a Markdown, text or PDF site: what a download of the original is called. Its bytes are at `source.md`, `source.txt` or `document.pdf` among the site''s files.'
          example: q3-report.md
        updatedAt:
          type: string
          description: When the site was last changed (ISO-8601, UTC).
          format: date-time
        projectId:
          type:
          - string
          - 'null'
          description: Owning project, or null when unfiled.
          format: uuid
        suspendedAt:
          type:
          - string
          - 'null'
          description: When an operator suspended this site, or null. A suspended site is not served to visitors and cannot be edited or deleted until it is restored.
          format: date-time
        suspensionReason:
          type:
          - string
          - 'null'
          description: Why it was suspended, in the operator's words. Only returned to a site admin — the owner is who this is written for.
        freeLink:
          type: boolean
          description: 'True for a free link: a page made without an account that stops working at `expiresAt`. False for every site in an account, kept free links included.'
          example: false
        expiresAt:
          type:
          - string
          - 'null'
          description: When the site stops being served (ISO-8601, UTC), or null for never. Only free links have one.
          format: date-time
        owned:
          type:
          - boolean
          - 'null'
          description: True when the caller owns this site. Only on list endpoints.
        commentCount:
          type:
          - integer
          - 'null'
          description: Total comments on the site. Only on list endpoints.
          format: int64
        collaborators:
          type:
          - array
          - 'null'
          description: Owner plus direct user grants, deduped and capped at 5, for avatar chips. Only on list endpoints.
          items:
            type: string
            description: A token `sub`.
      description: A site, with the calling user's effective role on it.
    ClaimFreeLinkRequest:
      required:
      - claimToken
      type: object
      properties:
        claimToken:
          type: string
          description: The one-time token returned when the free link was made.
  securitySchemes:
    bearer-jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT