---
title: "GET /v1/modules"
method: GET
path: "/v1/modules"
tags: ["modules"]
---

# GET /v1/modules

`GET /v1/modules`

## Request

- Base URL: `https://help.steep.app` (the document declares no server; this is the origin it was published from)
- URL: `https://help.steep.app/v1/modules`
- Auth: none declared

List modules for your workspace.

## Response `200`

Response for status 200

- object
  - `total` number, required
  - `limit` number, required
  - `skip` number, required
  - `data` object[], required
    - `id` string, required: Unique resource ID (opaque).
    - `label` unknown, required
    - `description` unknown, required
    - `identifier` string, required: Readable semantic model key. Used to cross-reference objects in the semantic model.
    - `table` string, required
    - `schema` string, required
    - `externalSource` 'dbt-cloud' | 'cube' | 'code', required
    - `synonyms` string[], required: Other names people use for this, e.g. abbreviations or terms in other languages.
    - `agentInstructions` unknown, required

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `422`: Response for status 422
- `429`: Response for status 429
- `500`: Response for status 500

---

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