---
title: "GET /workbench/series/{WorkbenchId}"
method: GET
path: "/workbench/series/{WorkbenchId}"
tags: ["Workbench"]
---

# GET /workbench/series/{WorkbenchId}

`GET /workbench/series/{WorkbenchId}`

Retrieve the workbench series information for the given workbench id and categories

## Path parameters

- `WorkbenchId` string, uuid, required

## Query parameters

- `includeHidden` boolean
- `categoryNames` string[]
- `categoryIds` string[]

## Response `200`

OK

- WorkbenchSeries
  - `primaryIndicator` WorkbenchIndicatorSeries
    - `provider` string, uuid
    - `providerId` string, nullable
    - `name` string, nullable — Indicator name.
    - `offset` integer — The offset applied to the indicator in the workbench.
    - `incompatible` boolean — If the indicator is compatible with the workbench's selected calculation and frequency.
    - `points` Point[], nullable — Indicator points converted to workbench frequency and calculation with offset.
      - `value` number, double
      - `date` string, date-time
      - `annotation` string, nullable
      - `manuallyAdjusted` boolean
      - `isForecasted` boolean, nullable
    - `transformations` Transformation[], nullable — The transformations applied to the series and the order they were applied
      - `order` integer
      - `required` boolean
  - `workbenchIndicators` WorkbenchIndicatorSeries[], nullable — Indicator series information for indicators on workbench.
    - `provider` string, uuid
    - `providerId` string, nullable
    - `name` string, nullable — Indicator name.
    - `offset` integer — The offset applied to the indicator in the workbench.
    - `incompatible` boolean — If the indicator is compatible with the workbench's selected calculation and frequency.
    - `points` Point[], nullable — Indicator points converted to workbench frequency and calculation with offset.
      - `value` number, double
      - `date` string, date-time
      - `annotation` string, nullable
      - `manuallyAdjusted` boolean
      - `isForecasted` boolean, nullable
    - `transformations` Transformation[], nullable — The transformations applied to the series and the order they were applied
      - `order` integer
      - `required` boolean

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `429` — If the user has sent too many requests

---

[API](https://skmtc.net/prevedere/apis/board-foresight-api-v1.md) · [All operations](https://skmtc.net/prevedere/apis/board-foresight-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prevedere/board-foresight-api-v1/revisions/c5ac8232e334/schema)