---
title: "List parameters"
method: GET
path: "/workspaces/{workspace_id}/parameters"
tags: ["Parameters"]
---

# List parameters

`GET /workspaces/{workspace_id}/parameters`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/parameters`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

List parameters with pagination, search, and filtering

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

## Query parameters

- `limit` integer: Max number of result to return
- `offset` integer: Distance from the beginning of the list of results
- `search` string, nullable: Search parameters by name or description
- `group_id` integer, nullable: Filter parameters by group ID
- `sort` string, nullable: Sort parameters by field
- `project_id` integer, nullable: Filter by project ID. Omit for workspace-scoped only.

## Response `200`

List ParameterListResponse

- ParameterListResponse
  - `total_count` integer, required
  - `offset` integer, required
  - `limit` integer, required
  - `next` string, required
  - `items` ParameterResponse[], required
    - `id` integer, required
    - `name` string, required
    - `value` union, required
      - string
      - number
      - integer
    - `param_type` string, required
    - `description` string, nullable
    - `scope` string, required
    - `group_id` integer, nullable
    - `group_name` string, nullable
    - `pipeline_count` integer, required
    - `stale_pipelines` integer[]
    - `created_by` integer, required
    - `created_at` string, required
    - `updated_by` integer, nullable
    - `updated_at` string, required

## Other responses

- `400`: Bad Request
- `401`: Authorization error
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)