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

# List Modules

`GET /modules`

This endpoint lists modules by various filters.

To list modules accessible from a certain environment, `filter[environment]` has to be
specified. Modules from the account which this environment belongs as well as
globally published modules will be listed as well.

To list modules accessible from a certain account, `filter[account]` has to be specified.
Modules published globally will be listed as well.

To list modules accessible globally, both `filter[account]=null` and
`filter[environment]=null` have to be specified.

If no filters were specified, all modules which the user has read access to will be
listed.

## Query parameters

- `page[number]` string
- `page[size]` string
- `filter[name]` string
- `filter[provider]` string
- `filter[source]` string
- `filter[status]` string
- `filter[source-type]` string
- `filter[environment]` string
- `filter[module]` string
- `filter[account]` string
- `filter[module-versions][status]` string
- `filter[module-versions][is-root-module]` string
- `filter[vcs-provider]` string
- `query` string
- `filter[module-namespace]` string
- `filter[namespace][environments]` string
- `include` string[]
- `sort` string[]
- `fields` object
  - `docker-integrations` string — The comma-separated list of fields to return in response for DockerIntegration resource.
  - `environments` string — The comma-separated list of fields to return in response for Environment resource.
  - `module-namespaces` string — The comma-separated list of fields to return in response for ModuleNamespace resource.
  - `module-versions` string — The comma-separated list of fields to return in response for ModuleVersion resource.
  - `modules` string — The comma-separated list of fields to return in response for Module resource.
  - `users` string — The comma-separated list of fields to return in response for User resource.
  - `vcs-providers` string — The comma-separated list of fields to return in response for VcsProvider resource.

## Response `200`

Success.

## Other responses

- `404` — Modules not found, or user unauthorized to perform action.
- `4XX` — Client error.
- `5XX` — Server error.

---

[API](https://skmtc.net/scalr/apis/scalr-iacp-api.md) · [All operations](https://skmtc.net/scalr/apis/scalr-iacp-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalr/scalr-iacp-api/versions/fc927526ad12/schema)