REST API Overview

In order to interface with some of the core functionality, Vouch has exposed specific resources via a REST API. This gives developers a great deal of flexibility when integrating Vouch and opens up the doors to very exciting activations.

The Vouch REST API is only available for customers who have purchased the entitlement as part of their plan.

Base URL

The API is accessed using a base URL in the form:

https://api.vouchfor.com/api/v1/<resource>  

Authentication

All requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named X-API-KEY .

"X-API-KEY: YOUR_TOKEN" https://api.vouchfor.com/api/v1/<resource>  

Your API Key can be found in your account on the the Developer page within your Vouch Account. The REST API is only available for customers who have purchased the entitlement as part of their plan.

HTTP Method

The v1 API uses standard HTTP methods for indicating the action to take on a resource.

Schema

All API requests and response bodies adhere to a common JSON format representing individual items and collections of items.

Errors

The API uses HTTP status codes to indicate an error has occurred while processing a request. There are five main error status codes used by the API:

REST API Calls

Vouch currently offers a suite of RESTful API endpoints. These APIs have be grouped under the section of the Platform they relate to. To find out more about a specific API call, simply click on the event below.

The endpoints are grouped by the area of the platform they relate to. Select an endpoint to see its full reference, including parameters and example responses, on the Vouch Developer Portal.

Advocacy

Audio

Campaign (Requests)

Chat

Clip

Composition

Content

Document

Entity

File

Image

Link

Meeting

Playlist

Project

Tag

Vouch (Videos)