Projects

Lists the projects the caller can reach.

With a project API token, that is the authenticated root project and its subprojects. With a Personal access token, it is every root project the token holder is enabled for, plus their subprojects.

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

With a project API token, the token must have the following scope(s) enabled to make a successful request: Management.

With a Personal access token there are no scopes. The token holder must be an owner or admin of the space, and the request reaches only the projects the holder is enabled for, plus their subprojects.

Learn more about API scopes.

get/api/projects

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/projects
  • Auth
    • HTTP basic
    • or HTTP basic

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"
    }
  ]
}

Changes

    • info

      the endpoint scheme security SignalWireBasicAuth was added to the API

    • info

      the endpoint scheme security SignalWirePersonalAccessTokenAuth was added to the API

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

Some revisions have not been checked yet.