How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SPOTIO Users API

The controller is responsible for handling the creation, updating, deleting Spotio Users.This controller allow users to exchange of credentials for a token.

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

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 14 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://api.spotio2.com, https://app-test.spotio2.com.

16 operations 14 paths 19 schemas 7 GET7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.spotio2.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

SPOTIO Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Enter the Bearer Authorization string as following: Bearer Generated-JWT-Token

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 7 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 16

The controller is responsible for handling the creation, updating, deleting Spotio Users. This controller allow users to exchange of credentials for a token.

POST
/api/Users
Create a new Spotio User
body → 200400401415422500
POST
/api/auth/token
body → 200400401415422500
PUT
/api/users/{id}
Update exising user by id
1 param body → 200400401415422500
POST
/api/users/{id}/block
Block existing user by Id
1 param → 200400401415422500
GET
/api/users/details
Get users list with search parameters.
6 params → 200400401
GET
/api/users
Get user list
1 param → 200400401415422500
GET
/api/users/listdeprecated
Get paginated user list (deprecated, use /api/v2/users/list)
8 params → 200400401415422500
GET
/api/v2/users/list
Get paginated and filtered user list
9 params → 200400401415422500
GET
/api/users/externalSystemUserId
Get user by external system user id
1 param → 200400401415422500
GET
/api/users/search
Search users
8 params → 200400401415422500
POST
/api/users/search
Search users
body → 200400401415422500
GET
/api/users/search/totalCount
Search users total count
8 params → 200400401415422500
POST
/api/users/search/totalCount
Search users total count
body → 200400401415422500
POST
/api/users/{id}/invite
Resend invitation for user
1 param → 200400401415422500
PUT
/api/users/{userId}/profile-picture
Change user profile picture
1 param body → 200400401415422500
POST
/api/users/apitoken
body → 200400401403404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Spotio.Frontend.ViewModel.Users.AvailableFeatures (150 properties), Spotio.Frontend.ViewModel.Users.UserFull (55 properties), Spotio.Frontend.ViewModel.Users.UserDetails (34 properties), Spotio.Frontend.ViewModel.Users.Channels (26 properties). Each schema is shown below with its type and property counts.

Spotio.Authorization.Client.DTO.WebStatus
string
Spotio.Frontend.ViewModel.Users.Tokens
object
The response containing access and refresh tokens.
5 properties
Spotio.Frontend.ViewModel.Users.UserSearchRequest
object
8 properties
Spotio.Infrastructure.Common.DataModel.Error.Error
object
1 property
Spotio.Frontend.ViewModel.Users.ChangeProfilePictureRequest
object
Request to change a user's profile picture
1 property
Spotio.Frontend.ViewModel.Users.ApiTokenRequest
object
A request object used to authenticate a client and get an API token.
3 properties
Spotio.Frontend.ViewModel.Users.UserDetails
object
Represents a simple user object.
34 properties
Spotio.Frontend.ViewModel.Users.UserFull
object
User with full details
55 properties
Spotio.Frontend.ViewModel.Users.User
object
Represents a simple user object.
16 properties
Spotio.Frontend.ViewModel.Users.AvailableFeatures
object
150 properties
Spotio.Frontend.ViewModel.Users.Channels
object
26 properties
Spotio.Frontend.ViewModel.Users.TokenRequest
object
The request for a new access token.
8 properties
Spotio.Frontend.ViewModel.Users.UsersSearchCountResponse
object
1 property
Spotio.Frontend.ViewModel.Users.UserSearchResponse
object
2 properties
Spotio.Frontend.ViewModel.Users.AuthorizationProvider
string
Spotio.Frontend.ViewModel.Users.SimpleUser
object
Represents a simple user object.
6 properties
Spotio.Authorization.Client.DTO.Platform
string
Spotio.Frontend.ViewModel.Users.ApiTokenResponse
object
1 property
Spotio.Frontend.ViewModel.Users.UsersListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spotio-users-api-openapi.yml Raw ↑

Other APIs SPOTIO publishes across the network.

SPOTIO Activities V2 API
SPOTIO Appointments V2 API
SPOTIO Autoplays API
SPOTIO Business Cards API
SPOTIO Calendar Settings API
SPOTIO Communication API
SPOTIO Communication Templates API
SPOTIO Connectors API
SPOTIO Contracts API
SPOTIO Data Objects API
SPOTIO Data Objects Bulk Jobs API
SPOTIO Data Objects Search API
Where this information came from

This is an independent, third-party profile of SPOTIO Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.