Appfire Periods API

Query OKR time periods. Periods define the time boundaries for OKR cycles, such as quarters or custom date ranges.

Operations 2

GET /api/internal/periods Get periods by installation ID #
GET /api/internal/periods/{tenantId} Get periods by tenant ID #

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/appfire:appfire-periods-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.

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

OpenAPI Specification

appfire-periods-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OpenAPI definition Periods API
  version: v0
  description: Query OKR time periods. Periods define the time boundaries for OKR cycles, such as quarters or custom date ranges.
servers:
- url: http://okr-ppm-prod.appfire.com
  description: Generated server url
tags:
- name: Periods
  description: Query OKR time periods. Periods define the time boundaries for OKR cycles, such as quarters or custom date ranges.
paths:
  /api/internal/periods:
    get:
      tags:
      - Periods
      summary: Get periods by installation ID
      description: Retrieves all available OKR periods for a tenant identified by Forge installation ID.
      operationId: getAvailableAliasesByInstallationId
      parameters:
      - name: installationId
        in: query
        description: Forge installation ID of the tenant
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of periods
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PeriodAlias'
        '404':
          description: Host not found for installationId
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PeriodAlias'
  /api/internal/periods/{tenantId}:
    get:
      tags:
      - Periods
      summary: Get periods by tenant ID
      description: Retrieves all available OKR periods for a tenant. Prefer using the installationId query parameter; the tenantId path variable is deprecated.
      operationId: getAvailableAliases_1
      parameters:
      - name: tenantId
        in: path
        description: Tenant ID (deprecated, use installationId instead)
        required: true
        schema:
          type: string
      - name: installationId
        in: query
        description: Forge installation ID, preferred over tenantId path variable
        required: false
        schema:
          type: string
      responses:
        '200':
          description: List of periods
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PeriodAlias'
        '404':
          description: Host not found
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PeriodAlias'
      deprecated: true
components:
  schemas:
    PeriodAlias:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        startDate:
          type: string
          format: date-time
        deadline:
          type: string
          format: date-time
        appProvided:
          type: boolean
        hidden:
          type: boolean
      required:
      - deadline
      - name
      - startDate
x-provenance:
  method: harvested
  publisher: Appfire
  source: https://okr-ppm-prod.appfire.com/v3/api-docs
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)