space

List spaces

Returns all spaces the authenticated user belongs to. Use the is_default flag to identify the user's default space. To operate within a specific space, pass the X-Space-Id request header with the desired space ID.

get/spaces/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesspace_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Response

List of spaces the user belongs to.

idinteger required

Space ID.

namestring required

Display name of the space.

is_defaultboolean required

Whether this is the user's default space.

owner_emailstring email nullable

Email address of the space owner.

owner_first_namestring nullable

First name of the space owner.

owner_last_namestring nullable

Last name of the space owner.

Example response

[
  {
    "id": 7,
    "name": "My Organisation",
    "is_default": true,
    "owner_email": "owner@example.com",
    "owner_first_name": "Jane",
    "owner_last_name": "Doe"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.