---
title: "Get Forecasting Config"
method: GET
path: "/v1/forecasting/config/"
tags: ["forecasting_config"]
---

# Get Forecasting Config

`GET /v1/forecasting/config/`

## Request

- Base URL: `https://api.glyphic.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.glyphic.ai/v1/forecasting/config/`
- Auth: API key in header `X-API-Key`

Return public forecasting configuration for an API-key organization.

## Response `200`

Successful Response

- ForecastingConfig: Public forecasting calendar and category configuration.
  - `periods` ForecastingPeriodLabel[], required
    - `label` string, required
    - `cadence` 'monthly' | 'quarterly' | 'annual', required: Forecast period cadence exposed by the public API.
    - `start` string, date, required
    - `end` string, date, required
  - `visible_categories` string[], required
  - `fiscal_year_start` string, required
  - `default_cadence` 'monthly' | 'quarterly' | 'annual', required: Forecast period cadence exposed by the public API.
  - `boards` ForecastingConfigBoard[]
    - `id` string, required
    - `name` string, required
    - `filters` ForecastingConfigBoardFilters, required: Public board filters that define a forecast board's deal set.
      - `deal_types` string[], nullable
      - `forecast_categories` string[], nullable
      - `pipeline_ids` string[], nullable
      - `deal_segments` string[], nullable: CRM deal segment names, such as Salesforce Opportunity Record Types. Null means the board takes deals on any segment.
  - `current_period_quotas` ForecastingCurrentPeriodQuotas[]
    - `period` ForecastingPeriodLabel, required: One label that callers may use to filter forecast submissions.
      - `label` string, required
      - `cadence` 'monthly' | 'quarterly' | 'annual', required: Forecast period cadence exposed by the public API.
      - `start` string, date, required
      - `end` string, date, required
    - `quotas` ForecastingConfigQuota[]
      - `user` ForecastingConfigQuotaUser, required: Public identity attached to a live quota.
        - `id` string, required
        - `name` string, required
        - `email` string, email, required
      - `quota` number, required

## Other responses

- `401`: Unauthorized - Invalid or missing API key
- `404`: Forecasting not found
- `412`: CRM connection is unavailable
- `429`: CRM rate limited
- `503`: CRM temporarily unavailable

## Changes

- **2026-10-22** `37687308172e`: 1 info
  - added the optional property `boards/items/filters/deal_segments` to the response with the `200` status
- **2026-09-30** `f8d0e97df0a5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/glyphic/apis/airspeed-api/changes/v1/forecasting/config/get.md)

---

[API](https://skmtc.dev/glyphic/apis/airspeed-api.md) - [All operations](https://skmtc.dev/glyphic/apis/airspeed-api/llms.txt) - [OpenAPI document](https://skmtc.dev/glyphic/apis/airspeed-api/revisions/6ec6a32aa851?raw)