Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Kumospace

Kumospace Users API

The Users API from Kumospace — 26 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 29 operations across 26 paths, and defines 43 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, /.

29 operations 26 paths 43 schemas 2 DELETE11 GET9 POST7 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
1

Authentication & Security 1

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

Paths & Operations 29

Across 26 paths, the API surfaces 29 operations — 2 DELETE, 11 GET, 9 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 29
PUT
/v1/spaces/{name}/userRoles
Update a user role.
SetUserRole 1 param body → 200
GET
/v1/spaces/{name}/userRoles
Get user roles.
GetUserRoles 5 params → 200
PUT
/v1/spaces/{name}/userRoles/bulk
Update users roles in bulk.
SetUserRoleBulk 1 param body → 200
PUT
/v1/spaces/{name}/floorRoles
Updates an existing space's floor roles.
SetFloorRoles 1 param body → 204
GET
/v1/spaces/{name}/userRole
Get a user role by firebaseID.
GetUserRoleById 2 params → 200
GET
/v1/users/me/recentSpaces
Get user recently visited spaces.
GetUserRecentSpaces 2 params → 200
GET
/v1/users/me/recentSpaces/{name}
Get info about a user's recently visited space.
GetUserRecentSpace 1 param → 200
GET
/v1/users/me/defaultSpace
Get user default space.
GetUserDefaultSpace → 200
POST
/v1/users/fcmToken
Mobile users will send their FCM token for us to send push notifs
AddFcmToken body → 204
DELETE
/v1/users/fcmToken/{fcmToken}
De-associate FCM token from user when they logout of mobile This is to prevent users from sharing fcm tokens when logging in/out of one device
RemoveFcmToken 1 param → 204
GET
/v1/userInvitations/space/{spaceName}
Get all invitations sent for a certain space
GetInvitationsForSpace 1 param → 200
GET
/v1/invitations/{id}
Get expiring invitation details for the given id
GetExpiringInviteInfo 1 param → 200
POST
/v1/invitations
Create an expiring guest invitation
CreateExpiringInvitation body → 200
POST
/v1/userInvitations
Create and send a user invitation
CreateUserInvitation body → 200
PUT
/v1/userInvitations/{invitationId}
Create and send a user invitation
UpdateUserInvitation 1 param body → 204
DELETE
/v1/userInvitations/{invitationId}
Delete a user invitation
DeleteUserInvitation 1 param → 204
POST
/v1/userInvitations/bulk
Create and send bulk user invitations
CreateUserInvitationsBulk body → 200
POST
/v1/userInvitations/{invitationId}/resend
Resend
ResendInviteEmail 1 param → 204
POST
/v1/users/me/profile/form
Saves onboarding intake form for the user. This form will answer questions like who they are in their company and what they plan to do with Kumospace more deeply
SaveUserIntakeProfileForm body → 204
GET
/v1/users/me/profile/form/{spaceName}/response-required
Gets onboarding intake form for the user.
GetUserIntakeProfileFormStatus 1 param → 200
PUT
/v1/users/me/profile/{spaceName}
Updates a user's space-specific profile information
UpdateUserProfile 1 param body → 204
PUT
/v1/users/me
Updates a user's information
UpdateUser body → 204
GET
/v1/users/{userId}/publicInfo
Gets a user's public information
GetUserPublicInfo 1 param → 200
GET
/v1/users/{userId}/hipaaCompliant
Checks if a the user is a owner/member of a HIPAA space
IsUserHipaaCompliant 1 param → 200
GET
/v1/users/me/spaces/{spaceName}/kiosks
Get which kiosks a user has seen in a given space
GetSeenKiosks 1 param → 200
PUT
/v1/users/me/spaces/{spaceName}/kiosks
Update which kiosks a user has seen in a given space
UpdateSeenKiosks 1 param body → 200
POST
/v1/users/me/sendVerificationEmail
Send verification email for user.
SendVerificationEmail → 204
POST
/v1/users/me/bugReportdeprecated
HandleBugReport body → 204
POST
/v1/users/me/feedback
HandleUserFeedback body → 204

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are UserInvitation (18 properties), DbExpiringInvitation (8 properties), DbRecentlyVisitedSpace (7 properties), ApiUserIntakeProfileFormOthers (7 properties). Each schema is shown below with its type and property counts.

Email
string
Pattern for email
UserFeedbackEvent
object
5 properties 5 required
DbInviteStatus
string
UserRole
string
The user's role and permissions within a space.
ExpiryDuration.hour
string
PaginatedResponse_ApiUserRole_
object
A page of items. Useful for breaking up a large dataset into smaller chunks.
2 properties 2 required
ApiUserIntakeProfileFormOthers
object
7 properties 4 required
ApiCreateUserInvitationResponse
object
6 properties 5 required
DbRecentlyVisitedSpace
object
7 properties
PaginatedResponse_ApiRecentlyVisitedSpace_
object
A page of items. Useful for breaking up a large dataset into smaller chunks.
2 properties 2 required
ApiUserPublicInfo
object
2 properties 1 required
ClientUserRole
ApiDefaultSpaceResponse
object
1 property
ApiUpdateSpaceFloorRolesRequest
object
A request to update an existing space's floor roles for a user.
2 properties 2 required
ApiUserIntakeProfileFormFriendsAndFamily
object
5 properties 4 required
firestore.Timestamp
object
A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UT…
2 properties 2 required
ApiUserIntakeProfileForm
UserInvitationEmailSend
object
3 properties 3 required
ApiUpdateUserRequest
object
2 properties
ExpiryDuration.week
string
ApiIntakeFormStatusResponse
object
1 property 1 required
DbUserSpaceProfile
object
4 properties
ExpiryDuration.oneMonth
string
ApiRecentlyVisitedSpace
ApiCreateExpiringInvitationRequest
object
4 properties 2 required
ApiUserIntakeProfileFormEvents
object
5 properties 4 required
ExpiryDuration.day
string
FloorRole
string
ApiUpdateUserRoleRequest
A request to update a user's role within a space.
CustomerIoMessageStatus
string
ApiCreateUserInvitationRequest
object
4 properties 3 required
ApiUpdateUserInvitation
object
1 property 1 required
ApiFcmTokenRequest
object
1 property 1 required
DbExpiringInvitation
object
8 properties 6 required
ExpiryDuration.twoWeeks
string
ApiUserRole
object
6 properties 2 required
ApiUserIntakeProfileFormEducation
object
4 properties 3 required
ApiCreateUserInvitationBulk
object
1 property 1 required
ValidExpiryDuration
ApiCreateUserInvitationBulkRequest
object
3 properties 3 required
ApiUpdateSeenKiosksRequest
object
1 property 1 required
SpaceMetadata
UserInvitation
object
18 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kumospace-users-api-openapi.yml Raw ↑

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
#Users
← Back to K APIs
API Details
ID
kumospace:kumospace-users-api
Base URL
https://api.kumospace.com
Docs
https://api.kumospace.com/
Provider
Kumospace
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network