> ## Documentation Index
> Fetch the complete documentation index at: https://help.scribe-mail.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scribe API for email signatures, teammates, and campaigns

> The Scribe API is a REST API to manage email signatures, teammates, smart fields, and marketing campaigns in your workspace using JSON over HTTPS.

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

<Info>
  **Base URL**

  ```
  https://api.scribe-mail.com/v1
  ```
</Info>

## What you can build

| Resource                | Use the API to                                                            |
| ----------------------- | ------------------------------------------------------------------------- |
| **Signatures**          | Create, update, publish, install, and assign signature templates.         |
| **Teammates**           | Add the people whose signatures deploy, and set their smart field values. |
| **Emails**              | Manage teammate email addresses and aliases.                              |
| **Smart fields**        | Define the dynamic fields that populate signatures.                       |
| **Folders**             | Organize signature templates.                                             |
| **Assets**              | Upload the images and files used in signatures and campaigns.             |
| **Marketing campaigns** | Schedule, pause, and resume promotional banners.                          |
| **Integrations**        | Read the integrations connected to your workspace.                        |

<Tip>
  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.
</Tip>

## 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](/api-reference/authentication) to create a key and choose its scopes.

## Make your first request

This lists the signatures in your workspace:

```bash theme={null}
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:

```json theme={null}
{
  "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": { "page": 1, "limit": 50, "total_count": 1, "total_pages": 1, "has_more": false }
}
```

## Conventions

<CardGroup cols={2}>
  <Card title="JSON over HTTPS" icon="braces">
    All requests and responses are JSON. Send `Content-Type: application/json` on any request with a body.
  </Card>

  <Card title="UUIDs everywhere" icon="fingerprint">
    Every resource is addressed by a UUID, never a sequential id.
  </Card>

  <Card title="Versioned under /v1" icon="git-branch">
    The version is part of the path. New, backward-compatible fields can be added within `/v1`.
  </Card>

  <Card title="Pagination" icon="list">
    List endpoints return results in pages. See [Pagination](/api-reference/pagination).
  </Card>
</CardGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    Create an API key and scope it to the resources an integration needs.
  </Card>

  <Card title="Pagination" icon="arrow-right" href="/api-reference/pagination">
    Page through list endpoints with page and limit.
  </Card>

  <Card title="Errors" icon="triangle-alert" href="/api-reference/errors">
    Status codes and the JSON error envelope.
  </Card>

  <Card title="Signature content" icon="layers" href="/api-reference/signature-content">
    The block tree format for signature and campaign content.
  </Card>
</CardGroup>