API Reference

Welcome to the Voidfull API Reference.

• Use the sidebar to browse endpoints by tag
• See request/response examples and schemas
• Try out endpoints using the interactive sandboxes (where available)

If you're new to Voidfull, start with the Setup & Features, then come back here for details on specific endpoints.

Voidfull uses REST-ful APIs to build the backend on which it delivers content to the client side.

Path & Version

/api/{version}/

Each API is prefixed with the same path, followed by a specific version. Version strings are required and always start with v. The api versioning guide explains the current available versions and stability index.

For example

https://api.app.voidfull.com/api/v1/

Authentication

Authentication for the Voidfull API involves the use of an API key, which is a secure credential that is tied to your Voidfull account. This key should be included in the header of the request in the Authorization field as a string prefixed with Bearer.

--header 'Authorization: Bearer <VOIDFULL_API_KEY>'

For example, when using the @voidfull/js-sdk package, it should be imported and initialized with the API key, as shown in the snippet below.

import Voidfull from '@voidfull/js-sdk';

const Client = new Voidfull({
	siteId: 'VOIDFULL_SITE_ID',
	token: 'VOIDFULL_API_KEY'
});