---
title: "List projects"
method: GET
path: "/api/projects"
tags: ["Projects"]
---

# List projects

`GET /api/projects`

Lists the authenticated root project and its subprojects.

All endpoints operate only within the caller's project tree — the authenticated root
project and the subprojects beneath it.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Management_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

## Query parameters

- `name` string
- `page_size` integer
- `page_token` string
- `page_number` integer

## Response `200`

The request has succeeded.

- ProjectsProjectListResponse — A page of projects.
  - `links` ProjectsProjectPaginationLinks, required — Pagination links for a list of projects.
    - `self` string, uri, required — The link to the current page.
    - `first` string, uri, required — The link to the first page.
    - `next` string, uri — The link to the next page. Only present when more results exist.
    - `prev` string, uri — The link to the previous page. Only present when a previous page exists.
  - `data` ProjectsProject[], required — The projects on this page.
    - `id` string, uuid, required — Universal Unique Identifier.
    - `name` string, required — The name of the project.
    - `parent_project_id` string, uuid, required — Universal Unique Identifier.
    - `subproject` boolean, required — `true` when this project is a subproject.
    - `region_preference` string, required — The effective region preference for the project. Returned in all responses; it is not currently settable through this API.
    - `protect_recordings` boolean, required — When enabled, recordings created within the project require authentication to access.
    - `protect_message_media` boolean, required — When enabled, message media created within the project requires authentication to access.
    - `protect_fax_media` boolean, required — When enabled, fax media created within the project requires authentication to access.
    - `force_https_requests` boolean, required — When enabled, requests made to the project's webhooks and callbacks must use HTTPS.
    - `created_at` string, date-time, required — The date and time when the project was created.
    - `updated_at` string, date-time, required — The date and time when the project was last updated.

## Other responses

- `401` — Access is unauthorized.
- `500` — An internal server error occurred.

---

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