Retrieve the space

GET

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

Returns the space named by the request subdomain: its name, subdomain, verification and trial state, and timestamps.

Everything under /api/space is space-wide, so no project appears in the path. A Personal access token acts only on the space whose subdomain was called; the same token sent to another subdomain resolves no membership and is rejected with 401.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder’s role in the space is the whole authorization decision.

Returns the space named by the request subdomain: its name, subdomain, verification and trial state, and timestamps. Everything under `/api/space` is space-wide, so no project appears in the path. A Personal access token acts only on the space whose subdomain was called; the same token sent to another subdomain resolves no membership and is rejected with `401`. #### Permissions Authenticate with a [Personal access token](/docs/apis/authorization#personal-access-tokens) whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

Authentication

AuthorizationBasic

Personal access token authentication for space-wide administration.

Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project’s: it is created from your user menu in the Dashboard, is prefixed pat_, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space.

Example:

Authorization: Basic base64(:pat_...)

Personal access token authentication for space-wide administration. Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project's: it is created from your user menu in the Dashboard, is prefixed `pat_`, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space. Example: ``` Authorization: Basic base64(:pat_...) ```

Response

The request has succeeded.

typeenum

The object type. Always space.

idstringformat: "uuid"

The unique identifier of the space.

namestring

The name of the space.

subdomainstring

The subdomain of the space, which is the first label of its URL.

verifiedboolean

Whether the space has completed verification. An unverified space cannot use this API.

trialboolean

Whether the space is on a trial.

created_atdatetime

The date and time when the space was created.

updated_atdatetime

The date and time when the space was last updated.

Errors

401

Unauthorized Error

500

Internal Server Error