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

Qualtrics file API

The file API from Qualtrics — 3 operation(s) for file.

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

This API exposes 8 JSON Schema definitions.

Tagged areas include file. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 0.2.

Requests are made against a single base URL, https://{apiRegion}.qualtrics.com/API/{apiVersion}.

4 operations 3 paths 3 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.2
Base URL
https://yourdatacenterid.qualtrics.com/API/v3/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qualtrics file API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-TOKEN (QualtricsAPIKeyAuth). By default, every request must be authenticated.

Paths & Operations 4

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

file 4
POST
/automations/{automationId}/files
Upload a File
createFile 2 params → 200
GET
/automations/{automationId}/files/{fileId}
Get File Metadata
getFile 2 params → 200
DELETE
/automations/{automationId}/files/{fileId}
Delete File
deleteFile 2 params → 200
GET
/automations/{automationId}/files/{fileId}/content
Get File Content
getFileContent 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are metawarn (4 properties), meta (3 properties). Each schema is shown below with its type and property counts.

metawarn
object
4 properties 2 required
fileId
string
The file's unique Id. Since multiple files may share the same name, the id is used to identify a particular file. Multiple files may share the same name if The…
meta
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qualtrics-file-api-openapi.yml Raw ↑

Other APIs Qualtrics publishes across the network.

Qualtrics automations API
Qualtrics Directories API
Qualtrics Distributions API
Qualtrics Eventsubscriptions API
Qualtrics files API
Qualtrics Survey Definitions API