Skip to main content
The Scribe API is a REST API. Use it to manage email signatures, teammates, smart fields, folders, assets, and marketing campaigns programmatically, and to automate the work you would otherwise do by hand in the Scribe dashboard. Every request and response uses JSON over HTTPS. Resources are identified by UUID, and the API is versioned under /v1.
Base URL

What you can build

Browse the full endpoint reference in the sidebar, grouped by resource. Each endpoint page includes a request builder you can run with your own API key.

Authenticate your requests

Authenticate every request with a workspace API key, sent as a Bearer token:
A key acts as the member who created it, within a single workspace. See Authentication to create a key and choose its scopes.

Make your first request

This lists the signatures in your workspace:
A successful response returns a data array and a pagination object:

Conventions

JSON over HTTPS

All requests and responses are JSON. Send Content-Type: application/json on any request with a body.

UUIDs everywhere

Every resource is addressed by a UUID, never a sequential id.

Versioned under /v1

The version is part of the path. New, backward-compatible fields can be added within /v1.

Pagination

List endpoints return results in pages. See Pagination.

Next steps

Authentication

Create an API key and scope it to the resources an integration needs.

Pagination

Page through list endpoints with page and limit.

Errors

Status codes and the JSON error envelope.

Signature content

The block tree format for signature and campaign content.