Projects
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.
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.
get/api/projects
Query parameters
namestring
Filter projects by name.
page_sizeinteger
The number of results per page.
page_tokenstring
Cursor token for paging, taken from the links in a previous response.
page_numberinteger
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"
}
]
}