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 Documents API

The controller is responsible for handling the upload and retrieval of documents. Documents can be attached to data object, activity or be available company wide.

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

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

This API exposes 9 operations across 6 paths, and defines 10 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.

9 operations 6 paths 10 schemas 1 DELETE5 GET2 POST1 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 Documents 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 9

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

Documents 9

The controller is responsible for handling the upload and retrieval of documents. Documents can be attached to data object, activity or be available company wide.

POST
/api/Documents
Add a new document for existing dataObject
body → 200400401415422500
GET
/api/Documents
Get documents for existing dataObject
2 params → 200400401403415422500
GET
/api/Documents/paged
Get documents with pagination
4 params → 200400401415422500
POST
/api/Documents/paged
Get documents with pagination
body → 200400401415422500
GET
/api/Documents/company
Get all company documents
→ 200400401415422500
GET
/api/Documents/{documentId}
Get document by id
1 param → 200400401415422500
DELETE
/api/Documents/{documentId}
Delete existing document by id
1 param → 200400401415422500
GET
/api/Documents/{documentId}/url
Get document url by id
1 param → 200400401415422500
PUT
/api/Documents/company/{documentId}
Update company document
1 param body → 200400401415422500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Spotio.Frontend.ViewModel.Documents.Document (17 properties), Spotio.Frontend.ViewModel.Documents.GetDocumentsPagedRequest (5 properties), Spotio.Frontend.ViewModel.Documents.DocumentUploadRequest (4 properties), Spotio.Frontend.ViewModel.Documents.DocumentsPagedResponse (2 properties). Each schema is shown below with its type and property counts.

Spotio.Frontend.ViewModel.Documents.GetDocumentsPagedRequest
object
The request object for retrieving documents with pagination.
5 properties
Spotio.Frontend.ViewModel.Documents.DocumentUrlResponse
object
1 property
Spotio.Frontend.ViewModel.Documents.DocumentContextViewModel
string
Spotio.Frontend.ViewModel.Documents.UpdateCompanyDocumentRequest
object
2 properties
Spotio.Documents.Client.DTO.AiIndexingStatusDto
string
Spotio.Documents.Client.DTO.DocumentState
string
Spotio.Frontend.ViewModel.Documents.Document
object
17 properties
Spotio.Infrastructure.Common.DataModel.Error.Error
object
1 property
Spotio.Frontend.ViewModel.Documents.DocumentsPagedResponse
object
The response object for paginated documents.
2 properties
Spotio.Frontend.ViewModel.Documents.DocumentUploadRequest
object
The request object for uploading a document.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spotio-documents-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 Documents 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.