Overview#

Playbooks offers a REST API that'll help you access your account and perform most tasks.

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.

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.

The Playbooks API comes with the following:

• Authentication
• Pagination
• Error handling
• Rate limits
• Resources
• Webhooks

To learn more, please visit the appropriate section.

https://api.playbooks.xyz

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

npm install -g @playbooks/cli

yarn add @playbooks/cli

pnpm add @playbooks/cli