Overview#

Playbooks offers a REST API that'll let you access your account, all your account resources, and perform most tasks such as placing orders or downloading content.

Description#

The Playbooks API let's developers communicate programmatically with our servers in a secure, performant manner. This way, you can bypass the front-end user experience and craft your own programmatic experience based on your needs.

The Playbooks API follows a predictable, resource-oriented URL pattern and uses standard HTTP response codes, authentication, and verbs.

Base URL#

Terminal
https://api.playbooks.xyz

Client libraries#

Playbooks offers an NPM library for terminal access. To learn more, please visit our CLI docs.

Terminal
npm install -g @playbooks/cli

Data Formatting#

The Playbooks API follows the JSON API spec for incoming / outgoing requests. That said, we've taken a couple liberties to facilitate a more secure, performant DX in some situations. So, we encourage you to reference the documentation if something looks out of place -- before contacting support.

What's Included#

The Playbooks API comes with the following:

• Authentication
• Accounts
• Error handling
• Globals
• Pagination
• Rate limits

To learn more, please visit the appropriate section.

Support#