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

engageSPARK Files API

The Files API from engageSPARK — 2 operation(s) for files.

engageSPARK Files API is one of 7 APIs that engageSPARK publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.engagespark.com.

5 operations 2 paths 1 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.engagespark.com
Authentication
HTTP Token
License
Terms of Service
Resource Areas
1

Authentication & Security 1

engageSPARK Files API declares 1 security scheme for authenticating requests. It uses HTTP token authentication (apiToken). By default, every request must be authenticated.

  • apiToken — Token based HTTP authentication. Use the header "Authorization". The value must be the word "Token" followed by your token. For example: "Authorization: Token…

Paths & Operations 5

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

Files 5
GET
/v1/organizations/{orgId}/files/
Get all files of an organization
getFileList 2 params → 200401500
POST
/v1/organizations/{orgId}/files/
Upload files to storage
uploadFile 4 params body → 200400401500
GET
/v1/organizations/{orgId}/files/{filename}
Download a file by filename
downloadFile 2 params → 200401404500
POST
/v1/organizations/{orgId}/files/{filename}
Update a file metadata
updateFile 2 params body → 200400401404500
DELETE
/v1/organizations/{orgId}/files/{filename}
Delete a file from storage
deleteFile 2 params → 200401404500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is schema_file (8 properties). Each schema is shown below with its type and property counts.

schema_file
object
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagespark-files-api-openapi.yml Raw ↑

Other APIs engageSPARK publishes across the network.

engageSPARK Balance API
engageSPARK Campaigns API
engageSPARK Contacts API
engageSPARK SMS API
engageSPARK Top-Up API
engageSPARK WhatsApp API