List 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.
Filter by name when locating a project, or use Retrieve a project when you already have its ID. Integrations built around Compatibility API Account SIDs can use List accounts instead.
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.
Query parameters
Filter projects by name.
The number of results per page.
Cursor token for paging, taken from the links in a previous response.
The page index, used together with page_token.
Response
The request has succeeded.
Example response
{
"links": {
"self": "https://example-space.signalwire.com/api/projects?page_size=50",
"first": "https://example-space.signalwire.com/api/projects?page_size=50",
"next": "https://example-space.signalwire.com/api/projects?page_size=50&page_number=1&page_token=PA8f14e45f",
"prev": "https://example-space.signalwire.com/api/projects?page_size=50&page_number=0&page_token=PA8f14e45f"
},
"data": [
{
"name": "Acme Staging",
"subproject": true,
"region_preference": "us-west",
"force_https_requests": true,
"created_at": "2024-05-06T12:20:00Z",
"updated_at": "2024-05-06T12:20:00Z"
}
]
}Changes
Changed in 2 of the 137 revisions of this API.3
- ○
added the non-success response with the status
500response-non-success-status-added
- ○
removed the non-success response with the status
403response-non-success-status-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
endpoint added
endpoint-added
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
Of the 137 revisions, 3 have a changelog that could not be searched.