List modules

GET/api/v2/workspaces/{slug}/projects/{project_id}/modules/

List the modules in a project. Use it to build a delivery board, to find the module a sync run created, or to pull everything a person leads.

Results are paginated and, by default, ordered by sort_order, which is the order modules appear in the Plane UI.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring (uuid)

The project whose modules you want.

Query parameters

Filters

name:optionalstring

Return only modules whose name matches exactly, ignoring case. For a partial match, use search.

status:optionalstring

Return only modules in this lifecycle position. One of backlog, planned, in-progress, paused, completed, or cancelled.

Use status__in with a comma-separated list to match several at once, for example ?status__in=planned,in-progress.

lead_id:optionalstring (uuid)

Return only modules led by this user. Match is exact on the module's lead_id.

external_id:optionalstring

Return only modules carrying this external identifier. Pair it with external_source to resolve a record you imported from another system.

external_source:optionalstring

Return only modules that came from this system, for example github or jira.

is_archived:optionalboolean

true returns only archived modules. false returns only active modules, the same set as the default.

include_archived:optionalboolean

true returns archived and active modules together. Without it, the list hides archived modules. When you also pass is_archived, is_archived decides the result.

Search

search:optionalstring

Free-text match on the module name.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

sort_order , -sort_order
created_at , -created_at
id , -id

Defaults to sort_order.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. To go further, use cursor pagination.

paginate:optionalstring

Set to cursor to switch to the keyset envelope (no COUNT query), then follow next_cursor with ?cursor=.

count:optionalboolean

Set to false to skip the count query and omit total_count from the offset envelope. Defaults to true.

Cursor needs an explicit order_by

The default sort_order is not unique, so it can't back a stable keyset. A bare ?paginate=cursor returns 400 ordering_not_cursor_eligible. Pair it with a cursor-eligible ordering, such as ?paginate=cursor&order_by=created_at, or use offset pagination.

Enum filters are validated

status and status__in are checked against the allowed values. A typo like ?status=in_progress returns 400 invalid_request, not an empty result set.

Archived modules are hidden by default

The list leaves out modules with archived_at set unless you pass is_archived or include_archived. Send true or false in lowercase. Neither parameter is validated. include_archived widens the list only for true. Any is_archived value other than true or false lifts the default filter, so archived and active modules come back together.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: archived_at, backlog_issues, cancelled_issues, completed_issues, created_at, created_by_id, description, description_html, external_id, external_source, id, lead_id, logo_props, member_ids, name, sort_order, start_date, started_issues, status, target_date, total_issues, unstarted_issues, updated_at, updated_by_id.

List rows leave out description_html and the six progress counts (total_issues, backlog_issues, unstarted_issues, started_issues, completed_issues, cancelled_issues). Name them here, or pass all, to get them. See Progress counts.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: lead (the module lead), members (the module members).

Expanded objects get their own key: ?expand=state keeps state_id and adds a state object next to it, so an id is never replaced by an object. An unknown value returns 400.

?fields= and ?expand= take separate sets of names. Relation names aren't valid in ?fields=, field names aren't valid in ?expand=, and field filtering never removes an expanded object: ?fields=id,name&expand=state returns id, name and state. See Expanding relations.

Scopes

projects.modules:read

Errors

Status	Code	Cause
`401`	`unauthorized`	Missing or invalid credentials.
`402`	`payment_required`	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
`403`	`forbidden`	Your role or token scope can't read modules in this project.
`404`	`not_found`	No such workspace or project, or it's outside your tenant.
`406`	`not_acceptable`	The `Accept` header asks for a representation the API can't produce.
`429`	`rate_limited`	Throttled. Wait for the interval in `Retry-After` and retry.

List modules

bash

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/modules/?status=in-progress&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

python

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/modules/",
    headers={"X-Api-Key": "your-api-key"},
    params={"status": "in-progress", "per_page": 50},
)
print(response.json())

javascript

const params = new URLSearchParams({ status: "in-progress", per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/modules/?${params}`,
  {
    headers: { "X-Api-Key": "your-api-key" },
  },
);
const data = await response.json();

Response200

json

{
  "data": [
    {
      "id": "7c1f3d90-2a64-4e58-9b0d-3fa1c7e28b45",
      "name": "Billing revamp",
      "description": "Rework subscription billing end to end.",
      "start_date": "2026-01-05",
      "target_date": "2026-02-27",
      "status": "in-progress",
      "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "member_ids": [
        "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
        "9d3e1f27-8b4c-4a06-95f1-2c7ea45b0d18"
      ],
      "sort_order": 65535.0,
      "external_id": null,
      "external_source": null,
      "logo_props": {},
      "archived_at": null,
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    },
    {
      "id": "3ea77b18-5c9d-4f02-8a61-b0d4c9e5137a",
      "name": "Search relevance",
      "description": "",
      "start_date": null,
      "target_date": null,
      "status": "in-progress",
      "lead_id": null,
      "member_ids": [],
      "sort_order": 98302.5,
      "external_id": null,
      "external_source": null,
      "logo_props": {},
      "archived_at": null,
      "created_at": "2026-01-19T14:03:07.201884Z",
      "updated_at": "2026-01-19T14:03:07.201884Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response200

json

{
  "data": [
    {
      "id": "7c1f3d90-2a64-4e58-9b0d-3fa1c7e28b45",
      "name": "Billing revamp",
      "description": "Rework subscription billing end to end.",
      "start_date": "2026-01-05",
      "target_date": "2026-02-27",
      "status": "in-progress",
      "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "member_ids": [
        "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
        "9d3e1f27-8b4c-4a06-95f1-2c7ea45b0d18"
      ],
      "sort_order": 65535.0,
      "external_id": null,
      "external_source": null,
      "logo_props": {},
      "archived_at": null,
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next_cursor": "b3A9MTcx",
  "has_more": true,
  "pagination": {
    "style": "cursor"
  }
}

List modules ​

Path parameters ​

Query parameters ​

Response shaping ​

Scopes ​

Errors ​

List modules

Path parameters

Query parameters

Response shaping

Scopes

Errors