List projects

GET

https://{your_space_name}.signalwire.com/api/projects

GET

/api/projects

$ curl https://{your_space_name}.signalwire.com/api/projects \
>      -u "<project_id>:<api_token>"

1 {
2   "links": {
3     "self": "https://example-space.signalwire.com/api/projects?page_size=50",
4     "first": "https://example-space.signalwire.com/api/projects?page_size=50",
5     "next": "https://example-space.signalwire.com/api/projects?page_size=50&page_number=1&page_token=PA8f14e45f",
6     "prev": "https://example-space.signalwire.com/api/projects?page_size=50&page_number=0&page_token=PA8f14e45f"
7   },
8   "data": [
9     {
10       "id": "8f14e45f-ceea-467d-9c2b-7a1d3a9b2c34",
11       "name": "Acme Staging",
12       "parent_project_id": "b3877739-5c7e-4d4f-9d1a-2f0c8c2f1a11",
13       "subproject": true,
14       "region_preference": "us-west",
15       "protect_recordings": false,
16       "protect_message_media": false,
17       "protect_fax_media": false,
18       "force_https_requests": true,
19       "created_at": "2024-05-06T12:20:00Z",
20       "updated_at": "2024-05-06T12:20:00Z"
21     }
22   ]
23 }

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.

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).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Query parameters

namestringOptional

Filter projects by name.

page_sizeintegerOptional1-1000Defaults to 50

The number of results per page.

page_tokenstringOptional

Cursor token for paging, taken from the links in a previous response.

page_numberintegerOptional>=0Defaults to 0

The page index, used together with page_token.

Response

The request has succeeded.

linksobject

Pagination links for the list of projects.

datalist of objects

The projects on this page.

Errors

401

Unauthorized Error

500

Internal Server Error