Kumospace Spaces API

The Spaces API from Kumospace — 13 operation(s) for spaces.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kumospace Spaces API is one of 23 APIs that Kumospace publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Spaces. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 18 operations across 13 paths, and defines 50 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, /.

18 operations 13 paths 50 schemas 2 DELETE10 GET1 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

Base URL

https://api.kumospace.com

Authentication

HTTP Bearer

Resource Areas

Authentication & Security 1

Kumospace Spaces API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (firebase).

Paths & Operations 18

Across 13 paths, the API surfaces 18 operations — 2 DELETE, 10 GET, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Spaces 18

GET

/v1/spaces

Get the user's spaces.

GetSpacesByOwner 3 params → 200

POST

/v1/spaces

Create a space.

CreateSpace body → 201

GET

/v1/spaces/{name}

Get a space by name.

GetSpaceByName 3 params → 200

PUT

/v1/spaces/{name}

Update a space.

UpdateSpace 1 param body → 204

DELETE

/v1/spaces/{name}

Delete a space.

DeleteSpace 1 param → 204

GET

/v1/spaces/{name}/publicInfo

Get public information about a space

GetSpacePublicInfoByName 1 param → 200

GET

/v1/spaces/{name}/chatConfig

Get a space's chat config

GetSpaceChatConfigByName 1 param → 200

GET

/v1/spaces/{name}/channels

Get a space's chat channels

GetSpaceUserChannels 2 params → 200

GET

/v1/spaces/{name}/customChannels

Get a space's custom channels

GetSpaceCustomChannels 2 params → 200

PUT

/v1/spaces/{name}/home

Update a user's spawn home.

UpdateHome 1 param body → 204

DELETE

/v1/spaces/{name}/home

Delete a user's spawn home.

DeleteHome 1 param → 204

PUT

/v1/spaces/{name}/trial

Start a free trial if space never got one

StartInternalFreeTrial 1 param → 204

GET

/v1/spaces/{name}/trial

Retrieves free trial info

GetFreeTrialInfo 1 param → 200

GET

/v1/spaces/{name}/addMemberLink/{addMemberLinkId}

Start a free trial if space never got one

GetAddMemberLink 2 params → 200

PUT

/v1/spaces/{name}/prospected

Set a space as already prospected by Sales Team.

SetProspected 1 param body → 204

GET

/v1/spaces/{name}/ownerEmail

Get a space owner's email.

GetSpaceOwnerEmail 1 param → 200

PUT

/v1/spaces/{name}/defaultChannels

Updates a custom channel's settings

UpdateDefaultChannels 1 param body → 204

GET

/v1/spaces/{spaceName}/can-schedule-demo

Uses onboarding intake forms to determine if the space is a small company or not.

GetCanSpaceScheduleDemo 1 param → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are ApiSpace (32 properties), SendBirdUser (22 properties), ApiRoom (17 properties), SendbirdChannel (17 properties). Each schema is shown below with its type and property counts.

PrivacySettingType.public

string

RoomPrivacySettingType.closed

string

BillingPeriod

string

PrivacySettingType.registeredUsers

string

ChannelType

string

Pick_ApiPrivacySettings.type_

object

From T, pick a set of properties whose keys are in the union K

1 property 1 required

AutomaticStripeSubscription

object

10 properties 5 required

UserRole

string

The user's role and permissions within a space.

UserRole.member

string

SendBirdUser

object

22 properties 1 required

ApiUpdateProspectStatusRequest

object

1 property

Partial_ChatSettings_

object

Make all properties in T optional

6 properties

Record_Exclude_Range.Range.groupDm_.boolean_

object

Construct a type with a set of properties K of type T

5 properties

ApiUpdateSpaceRequest

object

A request to update an existing space.

9 properties

ApiSpace

object

A consolidated space model across v1 and v2.

32 properties 16 required

ApiChatConfigChannel

object

6 properties 6 required

ApiRoomFeatures

object

5 properties

PrivacySettingType.emailDomain

string

ApiSpacePermissions

object

15 properties

ApiPrivacySettings

Privacy settings as returned by the api.

PrivacySettingType.jwt

string

ApiRoom

object

A room within a space.

17 properties 14 required

PrivacySettingType.password

string

SingleTileBackground

object

A background with a single tile repeated across the room.

3 properties 3 required

ApiResponseRoomPrivacySettings

UserRole.admin

string

ApiSpacePublicInfo

object

A model for parameters of a space that are accessible without authentication.

5 properties 3 required

SubscriptionTier

string

ApiGetCanSpaceScheduleDemoResponse

object

1 property 1 required

SubscriptionEnvironment

string

UseCase

string

How the user plans to use the space.

RoomPrivacySettingType.open

string

BackgroundType.singleTile

string

ApiUpdateDefaultChannelsRequest

object

1 property 1 required

FloorRole

string

SpawnHome

object

3 properties 3 required

ApiCreateSpaceRequest

object

A request to create a new space.

9 properties 2 required

ApiGetSpaceOwnerEmailResponse

object

1 property

ChannelMetadata

object

9 properties 1 required

PrivacySettingType.guestList

string

PrivacySettingType.saml

string

ApiUpdateHomeRequest

object

A request to create or update a user's home in an existing room

3 properties 3 required

RoomPrivacySettingType.password

string

PrivacySettingType.closed

string

RoomPrivacySettings

SendbirdChannel

object

17 properties 13 required

AddMemberLink

object

9 properties 9 required

ApiChatConfig

object

6 properties 5 required

ChatSettings

Chat ranges available for Guests

PaginatedResponse_ApiSpace-or-ApiSpacePublicInfo_

object

A page of items. Useful for breaking up a large dataset into smaller chunks.

2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Kumospace publishes across the network.

Kumospace Account API

AE Profile APIs.io

Kumospace Analytics API

AE Profile APIs.io

Kumospace Calendar API

AE Profile APIs.io

Kumospace Chat API

AE Profile APIs.io

Kumospace Daily (Webhook) API

AE Profile APIs.io

Kumospace Demo API

AE Profile APIs.io

Kumospace Flooring API

AE Profile APIs.io

Kumospace Furniture API

AE Profile APIs.io

Kumospace Integrations API

AE Profile APIs.io

Kumospace MusicTrack API

AE Profile APIs.io

Kumospace Payments API

AE Profile APIs.io

Kumospace Recordings API

AE Profile APIs.io

#Spaces

← Back to K APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kumospace Spaces API

Metadata

Authentication & Security 1

Paths & Operations 18

Schemas 50

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kumospace Spaces API

Metadata

Authentication & Security 1

Paths & Operations 18

Schemas 50

Specification

Source

More from Kumospace 12

API Details

Provider

Explore more