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
https://api.scribe-mail.com/v1

​
What you can build

ResourceUse the API to
SignaturesCreate, update, publish, install, and assign signature templates.
TeammatesAdd the people whose signatures deploy, and set their smart field values.
EmailsManage teammate email addresses and aliases.
Smart fieldsDefine the dynamic fields that populate signatures.
FoldersOrganize signature templates.
AssetsUpload the images and files used in signatures and campaigns.
Marketing campaignsSchedule, pause, and resume promotional banners.
IntegrationsRead the integrations connected to your workspace.
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: 
Authorization: Bearer YOUR_API_KEY
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: 
curl https://api.scribe-mail.com/v1/signatures \
  -H "Authorization: Bearer YOUR_API_KEY"
A successful response returns a data array and a pagination object: 
{
  "data": [
    {
      "id": "3f1c2e9a-7b6d-4c5a-9f21-8e0d4b1a2c3d",
      "name": "Company signature",
      "priority": 1,
      "signature_installation_activated": true,
      "folder_id": null,
      "last_published_at": "2026-06-01T09:30:00Z",
      "created_at": "2026-05-20T14:00:00Z",
      "updated_at": "2026-06-01T09:30:00Z"
    }
  ],
  "pagination": { "next_cursor": null, "has_more": false, "limit": 50 }
}

​
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.

Cursor 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 cursors.

Errors

Status codes and the JSON error envelope.

Signature content

The block tree format for signature and campaign content.