shipstar-ai

shipstar-ai Changelog Subscriptions API

The changelog-subscriptions API from shipstar-ai — 3 operation(s) for changelog-subscriptions.

GitHub OpenAPI

Operations 4

POST /changelog/subscribe Subscribe To Changelog #
GET /changelog/confirm/{token} Confirm Changelog Subscription #
GET /changelog/unsubscribe/{token} Unsubscribe From Changelog #
POST /changelog/unsubscribe/{token} Unsubscribe From Changelog One Click #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/shipstar-ai/openapi/shipstar-ai-changelog-subscriptions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-upsert-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-mailing-list-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-remove-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-bulk-add-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-page-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-upsert-request-schema.json

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/shipstar-ai:shipstar-ai-changelog-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shipstar-ai-changelog-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shipstar Changelog Subscriptions API
  description: 'Public Shipstar REST API (v1). Authenticate with an API token from the dashboard: Authorization: Bearer . For agent access prefer the MCP server at https://mcp.shipstar.ai/mcp (OAuth 2.1, streamable HTTP). Responses carry standard RateLimit-* headers (and Retry-After on 429) so clients can self-throttle. Versioning & deprecation policy: https://docs.shipstar.ai/api-reference/versioning'
  version: 1.0.0
servers:
- url: https://api.shipstar.ai/api/v1
  description: Production
tags:
- name: changelog-subscriptions
paths:
  /changelog/subscribe:
    post:
      tags:
      - changelog-subscriptions
      summary: Subscribe To Changelog
      description: 'Subscribe an email address to a project''s changelog updates.

        Sends a confirmation email (double opt-in). No authentication required.

        Always returns 200 to prevent email enumeration.'
      operationId: subscribe_to_changelog_changelog_subscribe_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangelogSubscribeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangelogSubscribeResponse'
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — wait Retry-After seconds before retrying
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Rate limit exceeded. Please try again later.
      security: []
  /changelog/confirm/{token}:
    get:
      tags:
      - changelog-subscriptions
      summary: Confirm Changelog Subscription
      description: 'Confirm a changelog subscription via the token sent in the confirmation email.

        No authentication required.'
      operationId: confirm_changelog_subscription_changelog_confirm__token__get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — wait Retry-After seconds before retrying
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Rate limit exceeded. Please try again later.
      security: []
  /changelog/unsubscribe/{token}:
    get:
      tags:
      - changelog-subscriptions
      summary: Unsubscribe From Changelog
      description: 'Unsubscribe from changelog updates via the link in the email. A soft opt-out: the subscription is kept and marked unsubscribed, so re-subscribing later is a fresh double opt-in rather than a silent reactivation.

        No authentication required.'
      operationId: unsubscribe_from_changelog_changelog_unsubscribe__token__get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangelogUnsubscribeResponse'
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — wait Retry-After seconds before retrying
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Rate limit exceeded. Please try again later.
      security: []
    post:
      tags:
      - changelog-subscriptions
      summary: Unsubscribe From Changelog One Click
      description: 'RFC 8058 one-click unsubscribe target (List-Unsubscribe-Post header).


        Mail clients POST here without a body. No authentication required.'
      operationId: unsubscribe_from_changelog_one_click_changelog_unsubscribe__token__post
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangelogUnsubscribeResponse'
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — wait Retry-After seconds before retrying
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Rate limit exceeded. Please try again later.
      security: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ChangelogSubscribeRequest:
      properties:
        email:
          type: string
          format: email
          title: Email
        public_slug:
          type: string
          title: Public Slug
      type: object
      required:
      - email
      - public_slug
      title: ChangelogSubscribeRequest
    ChangelogSubscribeResponse:
      properties:
        message:
          type: string
          title: Message
      type: object
      required:
      - message
      title: ChangelogSubscribeResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChangelogUnsubscribeResponse:
      properties:
        message:
          type: string
          title: Message
      type: object
      required:
      - message
      title: ChangelogUnsubscribeResponse
  headers:
    RateLimitPolicy:
      description: 'Quota policy: <limit>;w=<window seconds>'
      schema:
        type: string
      example: 100;w=60
    RateLimitRemaining:
      description: Requests left in the current window
      schema:
        type: integer
      example: 99
    RetryAfter:
      description: Seconds to wait before retrying (on 429)
      schema:
        type: integer
      example: 60
    RateLimitLimit:
      description: Requests allowed in the current window
      schema:
        type: integer
      example: 100
    RateLimitReset:
      description: Seconds until the window resets
      schema:
        type: integer
      example: 60
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: Enter your API token (created in /dashboard/console).
x-deprecation-policy: https://docs.shipstar.ai/api-reference/versioning
x-sunset-policy: https://docs.shipstar.ai/api-reference/versioning