SuperSig.aiAPI v1

API Documentation

Integrate SuperSig.ai into your workflow. Manage campaigns, users, signatures, and analytics programmatically. All endpoints require an API key passed via the Authorization header.

Try It Out

Enter your API key below. You can generate one from Settings. The key is used only in the copy-to-clipboard curl snippets below.

No key set

Authentication

All API requests must include your API key in the Authorization header:

curl -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns

The word Bearer is not case-sensitive. A missing or unknown key gets a 401.

Base URL

https://www.supersig.ai/api/v1

Webhooks live under /api/v2. Responses are JSON with the result in data. Errors return { "error": "message" } with a 4xx or 5xx status.

Paging

The v1 lists (campaigns, users, signatures, templates) return one page at a time, newest first. Pass page (from 1) and limit (at most 100; the default is 100). Anything else gets a 400. Keep asking for the next page while hasMore is true.

GET https://www.supersig.ai/api/v1/users?page=2&limit=50

{
  "data": [
    "…"
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "hasMore": true
  }
}

Campaign field rules

A campaign that breaks one of these is refused with a 400 that names the field.

name: up to 200 characters.
imageUrl and ctaUrl: http or https URLs, up to 2048 characters.
ctaText: up to 100 characters.
startDate and endDate: ISO 8601 dates (or null); endDate cannot be before startDate.
isActive: true or false.
priority: a whole number from 0 to 100.
targetDepartments and targetRoles: lists of up to 100 strings, each up to 100 characters.

GET/api/v1/campaigns

List your organization's campaigns, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns?page=1&limit=50

Response

{
  "data": [
    {
      "id": "cmp_abc123",
      "orgId": "org_xyz",
      "name": "Spring Promo",
      "imageUrl": "https://cdn.example.com/spring.png",
      "ctaUrl": "https://example.com/spring",
      "ctaText": "See the offer",
      "startDate": "2026-03-01T00:00:00.000Z",
      "endDate": "2026-05-31T00:00:00.000Z",
      "isActive": true,
      "priority": 10,
      "targetDepartments": [
        "Sales"
      ],
      "targetRoles": [],
      "createdAt": "2026-02-20T17:04:00.000Z",
      "updatedAt": "2026-02-20T17:04:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "hasMore": false
  }
}

POST/api/v1/campaigns

Create a campaign. name, imageUrl, ctaUrl and ctaText are required; startDate, endDate, isActive (default true), priority (default 0), targetDepartments and targetRoles are optional. See Campaign field rules below.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "name": "Summer Sale",\n  "imageUrl": "https://cdn.example.com/summer.png",\n  "ctaUrl": "https://example.com/summer",\n  "ctaText": "Shop the sale",\n  "startDate": "2026-06-01",\n  "endDate": "2026-08-31",\n  "priority": 5\n}' \
  https://www.supersig.ai/api/v1/campaigns

Request Body

{
  "name": "Summer Sale",
  "imageUrl": "https://cdn.example.com/summer.png",
  "ctaUrl": "https://example.com/summer",
  "ctaText": "Shop the sale",
  "startDate": "2026-06-01",
  "endDate": "2026-08-31",
  "priority": 5
}

Response

{
  "data": {
    "id": "cmp_abc123",
    "orgId": "org_xyz",
    "name": "Summer Sale",
    "imageUrl": "https://cdn.example.com/spring.png",
    "ctaUrl": "https://example.com/spring",
    "ctaText": "See the offer",
    "startDate": "2026-03-01T00:00:00.000Z",
    "endDate": "2026-05-31T00:00:00.000Z",
    "isActive": true,
    "priority": 10,
    "targetDepartments": [
      "Sales"
    ],
    "targetRoles": [],
    "createdAt": "2026-02-20T17:04:00.000Z",
    "updatedAt": "2026-02-20T17:04:00.000Z"
  }
}

GET/api/v1/campaigns/:id

Get one campaign. 404 if it is not in your organization.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns/:id

Response

{
  "data": {
    "id": "cmp_abc123",
    "orgId": "org_xyz",
    "name": "Spring Promo",
    "imageUrl": "https://cdn.example.com/spring.png",
    "ctaUrl": "https://example.com/spring",
    "ctaText": "See the offer",
    "startDate": "2026-03-01T00:00:00.000Z",
    "endDate": "2026-05-31T00:00:00.000Z",
    "isActive": true,
    "priority": 10,
    "targetDepartments": [
      "Sales"
    ],
    "targetRoles": [],
    "createdAt": "2026-02-20T17:04:00.000Z",
    "updatedAt": "2026-02-20T17:04:00.000Z"
  }
}

PUT/api/v1/campaigns/:id

Change a campaign. Send only the fields you are changing; the same rules apply as on create.

Example Request

curl -X PUT \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "name": "Spring Promo (extended)",\n  "endDate": "2026-06-15"\n}' \
  https://www.supersig.ai/api/v1/campaigns/:id

Request Body

{
  "name": "Spring Promo (extended)",
  "endDate": "2026-06-15"
}

Response

{
  "data": {
    "id": "cmp_abc123",
    "orgId": "org_xyz",
    "name": "Spring Promo (extended)",
    "imageUrl": "https://cdn.example.com/spring.png",
    "ctaUrl": "https://example.com/spring",
    "ctaText": "See the offer",
    "startDate": "2026-03-01T00:00:00.000Z",
    "endDate": "2026-06-15T00:00:00.000Z",
    "isActive": true,
    "priority": 10,
    "targetDepartments": [
      "Sales"
    ],
    "targetRoles": [],
    "createdAt": "2026-02-20T17:04:00.000Z",
    "updatedAt": "2026-02-20T17:04:00.000Z"
  }
}

DELETE/api/v1/campaigns/:id

Delete a campaign permanently.

Example Request

curl -X DELETE \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns/:id

Response

{
  "data": {
    "deleted": true
  }
}

GET/api/v1/users

List your organization's users, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/users?page=2&limit=50

Response

{
  "data": [
    {
      "id": "usr_abc123",
      "email": "jane@company.com",
      "name": "Jane Smith",
      "role": "admin",
      "department": "Marketing",
      "platform": "google",
      "signatureTemplateId": "tpl_xyz789",
      "lastSeenAt": "2026-03-10T14:30:00.000Z",
      "createdAt": "2026-01-15T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "hasMore": true
  }
}

GET/api/v1/users/:id

Get one user. 404 if they are not in your organization.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/users/:id

Response

{
  "data": {
    "id": "usr_abc123",
    "email": "jane@company.com",
    "name": "Jane Smith",
    "role": "admin",
    "department": "Marketing",
    "platform": "google",
    "signatureTemplateId": "tpl_xyz789",
    "lastSeenAt": "2026-03-10T14:30:00.000Z",
    "createdAt": "2026-01-15T00:00:00.000Z"
  }
}

GET/api/v1/signatures

List your organization's signatures, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/signatures

Response

{
  "data": [
    {
      "id": "sig_abc123",
      "userId": "usr_abc123",
      "name": "Work signature",
      "templateKey": "professional",
      "fullName": "Jane Smith",
      "title": "VP of Marketing",
      "company": "Acme Inc",
      "phone": "+1 555-0123",
      "deployedAt": "2026-03-10T14:30:00.000Z",
      "createdAt": "2026-02-01T00:00:00.000Z",
      "updatedAt": "2026-03-10T14:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "hasMore": false
  }
}

POST/api/v1/signatures

Deploys a signature to the user's live Gmail mailbox right away, replacing the signature they have now. It does not create a draft. Microsoft 365 users cannot be deployed to yet (the call returns 500 with the reason). userId is required. templateId is optional; without it the user's assigned template is used, and the call fails with 400 if they have none.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "userId": "usr_abc123",\n  "templateId": "tpl_xyz789"\n}' \
  https://www.supersig.ai/api/v1/signatures

Request Body

{
  "userId": "usr_abc123",
  "templateId": "tpl_xyz789"
}

Response

{
  "data": {
    "deployed": true,
    "userId": "usr_abc123"
  }
}

GET/api/v1/templates

List your organization's templates, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/templates

Response

{
  "data": [
    {
      "id": "tpl_xyz789",
      "name": "Company standard",
      "htmlContent": "<table>…</table>",
      "variables": [
        "fullName",
        "title"
      ],
      "role": null,
      "isActive": true,
      "createdAt": "2026-01-10T00:00:00.000Z",
      "updatedAt": "2026-01-10T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "hasMore": false
  }
}

POST/api/v1/templates

Create a template. name and htmlContent are required; role and isActive (default true) are optional.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "name": "Sales team",\n  "htmlContent": "<table>…</table>",\n  "role": "sales"\n}' \
  https://www.supersig.ai/api/v1/templates

Request Body

{
  "name": "Sales team",
  "htmlContent": "<table>…</table>",
  "role": "sales"
}

Response

{
  "data": {
    "id": "tpl_new456",
    "name": "Sales team",
    "htmlContent": "<table>…</table>",
    "role": "sales",
    "isActive": true
  }
}

GET/api/v1/analytics

Totals and a per-campaign breakdown. Add &campaignId= to look at one campaign.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/analytics?days=30

Response

{
  "data": {
    "period": {
      "days": 30,
      "since": "2026-02-08T12:00:00.000Z"
    },
    "totals": {
      "impressions": 48200,
      "clicks": 3120,
      "ctr": "6.47"
    },
    "campaigns": [
      {
        "campaignId": "cmp_abc123",
        "name": "Spring Promo",
        "isActive": true,
        "impressions": 4820,
        "clicks": 312,
        "ctr": "6.47"
      }
    ]
  }
}

GET/api/v1/analytics/domains

Impressions and clicks grouped by the recipient's email domain, with a rough category (Business, Personal, Education…).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/analytics/domains?days=30

Response

{
  "data": {
    "domains": [
      {
        "domain": "bigcorp.com",
        "impressions": 1200,
        "clicks": 96,
        "ctr": "8.00",
        "category": "Business"
      }
    ]
  }
}

GET/api/v1/analytics/departments

Impressions and clicks grouped by the sender's department.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/analytics/departments?days=30

Response

{
  "data": {
    "period": {
      "days": 30,
      "since": "2026-02-08T12:00:00.000Z"
    },
    "departments": [
      {
        "department": "Sales",
        "impressions": 9100,
        "clicks": 640,
        "ctr": "7.03"
      }
    ]
  }
}

GET/api/v2/webhooks

List your webhook endpoints.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v2/webhooks

Response

{
  "data": [
    {
      "id": "wh_abc123",
      "url": "https://example.com/hooks/supersig",
      "events": [
        "campaign.created"
      ],
      "isActive": true,
      "createdAt": "2026-03-01T00:00:00.000Z"
    }
  ]
}

POST/api/v2/webhooks

Register an endpoint. url is required. events defaults to every event. secret is optional (at least 24 characters); without one we generate it. The secret is shown only in this response.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "url": "https://example.com/hooks/supersig",\n  "events": [\n    "campaign.created",\n    "campaign.updated"\n  ]\n}' \
  https://www.supersig.ai/api/v2/webhooks

Request Body

{
  "url": "https://example.com/hooks/supersig",
  "events": [
    "campaign.created",
    "campaign.updated"
  ]
}

Response

{
  "data": {
    "id": "wh_abc123",
    "url": "https://example.com/hooks/supersig",
    "events": [
      "campaign.created",
      "campaign.updated"
    ],
    "secret": "whsec_…",
    "isActive": true,
    "createdAt": "2026-03-01T00:00:00.000Z"
  }
}

GET/api/v2/webhooks/:id

Get one webhook endpoint.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v2/webhooks/:id

Response

{
  "data": {
    "id": "wh_abc123",
    "url": "https://example.com/hooks/supersig",
    "events": [
      "campaign.created"
    ],
    "isActive": true,
    "createdAt": "2026-03-01T00:00:00.000Z"
  }
}

PUT/api/v2/webhooks/:id

Change url, events or isActive. Send only what you are changing.

Example Request

curl -X PUT \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "isActive": false\n}' \
  https://www.supersig.ai/api/v2/webhooks/:id

Request Body

{
  "isActive": false
}

Response

{
  "data": {
    "id": "wh_abc123",
    "url": "https://example.com/hooks/supersig",
    "events": [
      "campaign.created"
    ],
    "isActive": false,
    "createdAt": "2026-03-01T00:00:00.000Z"
  }
}

DELETE/api/v2/webhooks/:id

Remove a webhook endpoint.

Example Request

curl -X DELETE \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v2/webhooks/:id

Response

{
  "data": {
    "deleted": true
  }
}

POST/api/v2/webhooks/test

Send a signed test.ping event to a URL, so you can check your receiver.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "url": "https://example.com/hooks/supersig",\n  "secret": "whsec_…"\n}' \
  https://www.supersig.ai/api/v2/webhooks/test

Request Body

{
  "url": "https://example.com/hooks/supersig",
  "secret": "whsec_…"
}

Response

{
  "data": {
    "success": true,
    "status": 200,
    "statusText": "OK"
  }
}

Webhooks

Get campaign, deployment, click, user and A/B test events pushed to your server, signed and retried. Read the webhook guide.

Rate Limits

API requests are rate-limited to 100 requests per minute per API key. If you exceed this limit, you will receive a 429 response. The Retry-After header indicates how many seconds to wait before retrying.

SuperSig.aiAPI v1

API Documentation

Integrate SuperSig.ai into your workflow. Manage campaigns, users, signatures, and analytics programmatically. All endpoints require an API key passed via the Authorization header.

Try It Out

Enter your API key below. You can generate one from Settings. The key is used only in the copy-to-clipboard curl snippets below.

No key set

Authentication

All API requests must include your API key in the Authorization header:

curl -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns

The word Bearer is not case-sensitive. A missing or unknown key gets a 401.

Base URL

https://www.supersig.ai/api/v1

Webhooks live under /api/v2. Responses are JSON with the result in data. Errors return { "error": "message" } with a 4xx or 5xx status.

Paging

GET https://www.supersig.ai/api/v1/users?page=2&limit=50

{
  "data": [
    "…"
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "hasMore": true
  }
}

Campaign field rules

A campaign that breaks one of these is refused with a 400 that names the field.

name: up to 200 characters.
imageUrl and ctaUrl: http or https URLs, up to 2048 characters.
ctaText: up to 100 characters.
startDate and endDate: ISO 8601 dates (or null); endDate cannot be before startDate.
isActive: true or false.
priority: a whole number from 0 to 100.
targetDepartments and targetRoles: lists of up to 100 strings, each up to 100 characters.

GET/api/v1/campaigns

List your organization's campaigns, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns?page=1&limit=50

Response

{
  "data": [
    {
      "id": "cmp_abc123",
      "orgId": "org_xyz",
      "name": "Spring Promo",
      "imageUrl": "https://cdn.example.com/spring.png",
      "ctaUrl": "https://example.com/spring",
      "ctaText": "See the offer",
      "startDate": "2026-03-01T00:00:00.000Z",
      "endDate": "2026-05-31T00:00:00.000Z",
      "isActive": true,
      "priority": 10,
      "targetDepartments": [
        "Sales"
      ],
      "targetRoles": [],
      "createdAt": "2026-02-20T17:04:00.000Z",
      "updatedAt": "2026-02-20T17:04:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "hasMore": false
  }
}

POST/api/v1/campaigns

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "name": "Summer Sale",\n  "imageUrl": "https://cdn.example.com/summer.png",\n  "ctaUrl": "https://example.com/summer",\n  "ctaText": "Shop the sale",\n  "startDate": "2026-06-01",\n  "endDate": "2026-08-31",\n  "priority": 5\n}' \
  https://www.supersig.ai/api/v1/campaigns

Request Body

{
  "name": "Summer Sale",
  "imageUrl": "https://cdn.example.com/summer.png",
  "ctaUrl": "https://example.com/summer",
  "ctaText": "Shop the sale",
  "startDate": "2026-06-01",
  "endDate": "2026-08-31",
  "priority": 5
}

Response

{
  "data": {
    "id": "cmp_abc123",
    "orgId": "org_xyz",
    "name": "Summer Sale",
    "imageUrl": "https://cdn.example.com/spring.png",
    "ctaUrl": "https://example.com/spring",
    "ctaText": "See the offer",
    "startDate": "2026-03-01T00:00:00.000Z",
    "endDate": "2026-05-31T00:00:00.000Z",
    "isActive": true,
    "priority": 10,
    "targetDepartments": [
      "Sales"
    ],
    "targetRoles": [],
    "createdAt": "2026-02-20T17:04:00.000Z",
    "updatedAt": "2026-02-20T17:04:00.000Z"
  }
}

GET/api/v1/campaigns/:id

Get one campaign. 404 if it is not in your organization.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns/:id

Response

{
  "data": {
    "id": "cmp_abc123",
    "orgId": "org_xyz",
    "name": "Spring Promo",
    "imageUrl": "https://cdn.example.com/spring.png",
    "ctaUrl": "https://example.com/spring",
    "ctaText": "See the offer",
    "startDate": "2026-03-01T00:00:00.000Z",
    "endDate": "2026-05-31T00:00:00.000Z",
    "isActive": true,
    "priority": 10,
    "targetDepartments": [
      "Sales"
    ],
    "targetRoles": [],
    "createdAt": "2026-02-20T17:04:00.000Z",
    "updatedAt": "2026-02-20T17:04:00.000Z"
  }
}

PUT/api/v1/campaigns/:id

Change a campaign. Send only the fields you are changing; the same rules apply as on create.

Example Request

curl -X PUT \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "name": "Spring Promo (extended)",\n  "endDate": "2026-06-15"\n}' \
  https://www.supersig.ai/api/v1/campaigns/:id

Request Body

{
  "name": "Spring Promo (extended)",
  "endDate": "2026-06-15"
}

Response

{
  "data": {
    "id": "cmp_abc123",
    "orgId": "org_xyz",
    "name": "Spring Promo (extended)",
    "imageUrl": "https://cdn.example.com/spring.png",
    "ctaUrl": "https://example.com/spring",
    "ctaText": "See the offer",
    "startDate": "2026-03-01T00:00:00.000Z",
    "endDate": "2026-06-15T00:00:00.000Z",
    "isActive": true,
    "priority": 10,
    "targetDepartments": [
      "Sales"
    ],
    "targetRoles": [],
    "createdAt": "2026-02-20T17:04:00.000Z",
    "updatedAt": "2026-02-20T17:04:00.000Z"
  }
}

DELETE/api/v1/campaigns/:id

Delete a campaign permanently.

Example Request

curl -X DELETE \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/campaigns/:id

Response

{
  "data": {
    "deleted": true
  }
}

GET/api/v1/users

List your organization's users, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/users?page=2&limit=50

Response

{
  "data": [
    {
      "id": "usr_abc123",
      "email": "jane@company.com",
      "name": "Jane Smith",
      "role": "admin",
      "department": "Marketing",
      "platform": "google",
      "signatureTemplateId": "tpl_xyz789",
      "lastSeenAt": "2026-03-10T14:30:00.000Z",
      "createdAt": "2026-01-15T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "hasMore": true
  }
}

GET/api/v1/users/:id

Get one user. 404 if they are not in your organization.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/users/:id

Response

{
  "data": {
    "id": "usr_abc123",
    "email": "jane@company.com",
    "name": "Jane Smith",
    "role": "admin",
    "department": "Marketing",
    "platform": "google",
    "signatureTemplateId": "tpl_xyz789",
    "lastSeenAt": "2026-03-10T14:30:00.000Z",
    "createdAt": "2026-01-15T00:00:00.000Z"
  }
}

GET/api/v1/signatures

List your organization's signatures, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/signatures

Response

{
  "data": [
    {
      "id": "sig_abc123",
      "userId": "usr_abc123",
      "name": "Work signature",
      "templateKey": "professional",
      "fullName": "Jane Smith",
      "title": "VP of Marketing",
      "company": "Acme Inc",
      "phone": "+1 555-0123",
      "deployedAt": "2026-03-10T14:30:00.000Z",
      "createdAt": "2026-02-01T00:00:00.000Z",
      "updatedAt": "2026-03-10T14:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "hasMore": false
  }
}

POST/api/v1/signatures

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "userId": "usr_abc123",\n  "templateId": "tpl_xyz789"\n}' \
  https://www.supersig.ai/api/v1/signatures

Request Body

{
  "userId": "usr_abc123",
  "templateId": "tpl_xyz789"
}

Response

{
  "data": {
    "deployed": true,
    "userId": "usr_abc123"
  }
}

GET/api/v1/templates

List your organization's templates, newest first. Paged: ?page= (from 1) and ?limit= (1 to 100, default 100).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/templates

Response

{
  "data": [
    {
      "id": "tpl_xyz789",
      "name": "Company standard",
      "htmlContent": "<table>…</table>",
      "variables": [
        "fullName",
        "title"
      ],
      "role": null,
      "isActive": true,
      "createdAt": "2026-01-10T00:00:00.000Z",
      "updatedAt": "2026-01-10T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "hasMore": false
  }
}

POST/api/v1/templates

Create a template. name and htmlContent are required; role and isActive (default true) are optional.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "name": "Sales team",\n  "htmlContent": "<table>…</table>",\n  "role": "sales"\n}' \
  https://www.supersig.ai/api/v1/templates

Request Body

{
  "name": "Sales team",
  "htmlContent": "<table>…</table>",
  "role": "sales"
}

Response

{
  "data": {
    "id": "tpl_new456",
    "name": "Sales team",
    "htmlContent": "<table>…</table>",
    "role": "sales",
    "isActive": true
  }
}

GET/api/v1/analytics

Totals and a per-campaign breakdown. Add &campaignId= to look at one campaign.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/analytics?days=30

Response

{
  "data": {
    "period": {
      "days": 30,
      "since": "2026-02-08T12:00:00.000Z"
    },
    "totals": {
      "impressions": 48200,
      "clicks": 3120,
      "ctr": "6.47"
    },
    "campaigns": [
      {
        "campaignId": "cmp_abc123",
        "name": "Spring Promo",
        "isActive": true,
        "impressions": 4820,
        "clicks": 312,
        "ctr": "6.47"
      }
    ]
  }
}

GET/api/v1/analytics/domains

Impressions and clicks grouped by the recipient's email domain, with a rough category (Business, Personal, Education…).

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/analytics/domains?days=30

Response

{
  "data": {
    "domains": [
      {
        "domain": "bigcorp.com",
        "impressions": 1200,
        "clicks": 96,
        "ctr": "8.00",
        "category": "Business"
      }
    ]
  }
}

GET/api/v1/analytics/departments

Impressions and clicks grouped by the sender's department.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v1/analytics/departments?days=30

Response

{
  "data": {
    "period": {
      "days": 30,
      "since": "2026-02-08T12:00:00.000Z"
    },
    "departments": [
      {
        "department": "Sales",
        "impressions": 9100,
        "clicks": 640,
        "ctr": "7.03"
      }
    ]
  }
}

GET/api/v2/webhooks

List your webhook endpoints.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v2/webhooks

Response

{
  "data": [
    {
      "id": "wh_abc123",
      "url": "https://example.com/hooks/supersig",
      "events": [
        "campaign.created"
      ],
      "isActive": true,
      "createdAt": "2026-03-01T00:00:00.000Z"
    }
  ]
}

POST/api/v2/webhooks

Register an endpoint. url is required. events defaults to every event. secret is optional (at least 24 characters); without one we generate it. The secret is shown only in this response.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "url": "https://example.com/hooks/supersig",\n  "events": [\n    "campaign.created",\n    "campaign.updated"\n  ]\n}' \
  https://www.supersig.ai/api/v2/webhooks

Request Body

{
  "url": "https://example.com/hooks/supersig",
  "events": [
    "campaign.created",
    "campaign.updated"
  ]
}

Response

{
  "data": {
    "id": "wh_abc123",
    "url": "https://example.com/hooks/supersig",
    "events": [
      "campaign.created",
      "campaign.updated"
    ],
    "secret": "whsec_…",
    "isActive": true,
    "createdAt": "2026-03-01T00:00:00.000Z"
  }
}

GET/api/v2/webhooks/:id

Get one webhook endpoint.

Example Request

curl -X GET \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v2/webhooks/:id

Response

{
  "data": {
    "id": "wh_abc123",
    "url": "https://example.com/hooks/supersig",
    "events": [
      "campaign.created"
    ],
    "isActive": true,
    "createdAt": "2026-03-01T00:00:00.000Z"
  }
}

PUT/api/v2/webhooks/:id

Change url, events or isActive. Send only what you are changing.

Example Request

curl -X PUT \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "isActive": false\n}' \
  https://www.supersig.ai/api/v2/webhooks/:id

Request Body

{
  "isActive": false
}

Response

{
  "data": {
    "id": "wh_abc123",
    "url": "https://example.com/hooks/supersig",
    "events": [
      "campaign.created"
    ],
    "isActive": false,
    "createdAt": "2026-03-01T00:00:00.000Z"
  }
}

DELETE/api/v2/webhooks/:id

Remove a webhook endpoint.

Example Request

curl -X DELETE \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://www.supersig.ai/api/v2/webhooks/:id

Response

{
  "data": {
    "deleted": true
  }
}

POST/api/v2/webhooks/test

Send a signed test.ping event to a URL, so you can check your receiver.

Example Request

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{\n  "url": "https://example.com/hooks/supersig",\n  "secret": "whsec_…"\n}' \
  https://www.supersig.ai/api/v2/webhooks/test

Request Body

{
  "url": "https://example.com/hooks/supersig",
  "secret": "whsec_…"
}

Response

{
  "data": {
    "success": true,
    "status": 200,
    "statusText": "OK"
  }
}

Webhooks

Get campaign, deployment, click, user and A/B test events pushed to your server, signed and retried. Read the webhook guide.

Try It Out

Authentication

Base URL

Paging

Campaign field rules

Campaigns

Example Request

Response

Example Request

Request Body

Response

Example Request

Response

Example Request

Request Body

Response

Example Request

Response

Users

Example Request

Response

Example Request

Response

Signatures

Example Request

Response

Example Request

Request Body

Response

Templates

Example Request

Response

Example Request

Request Body

Response

Analytics

Example Request

Response

Example Request

Response

Example Request

Response

Webhooks (v2)

Example Request

Response

Example Request

Request Body

Response

Example Request

Response

Example Request

Request Body

Response

Example Request

Response

Example Request

Request Body

Response

Webhooks

Rate Limits

Try It Out

Authentication

Base URL

Paging

Campaign field rules

Campaigns

Example Request

Response

Example Request

Request Body

Response

Example Request

Response

Example Request

Request Body

Response

Example Request

Response

Users

Example Request