Skip to main content

​
Activations

​
Overview

Activations are lead-generation experiences (forms, campaigns) belonging to a company. Use these endpoints to list and inspect activations and their associated forms. To link or embed the hosted activation form from your own site, see Conventions — Activation form page for the public URL patterns. There is no endpoint to submit into an activation — data of record is captured on the hosted flow and delivered via Webhooks.

​
Endpoints

​
List activations

  • Method: GET
  • Path: /api/v1/{company}/activations
  • Scope: activations:read
  • Subscription: USE_API

​
Path parameters

NameTypeDescription
companystringCompany sqid

​
Query parameters

NameTypeDescription
qstringFilter by title (substring match)
pageintegerPage number (default: 1)

​
Response 200

{
  "data": [
    {
      "id": "summer-campaign",
      "redirect_url": "https://example.com/thanks",
      "slug": "summer-campaign",
      "status": "published",
      "title": "Summer Campaign",
      "type": "Form",
      "created_at": "2026-01-20T08:00:00.000+00:00"
    }
  ],
  "links": { "...": "..." },
  "meta": { "...": "..." }
}
The form relation is not included in list responses.

​
Response fields

FieldTypeDescription
idstringActivation slug
redirect_urlstring|nullPost-submission redirect URL
slugstringURL slug
statusstringActivation status
titlestringDisplay title
typestringHuman-readable activation type label
created_atstringISO 8601 timestamp

​
Errors

StatusWhen
401Missing or invalid token
403Missing scope, subscription, or company access

​
Show activation

  • Method: GET
  • Path: /api/v1/{company}/activations/{activation}
  • Scope: activations:read
  • Subscription: USE_API

​
Path parameters

NameTypeDescription
companystringCompany sqid
activationstringActivation slug

​
Query parameters

None.

​
Response 200

{
  "data": {
    "id": "summer-campaign",
    "redirect_url": "https://example.com/thanks",
    "slug": "summer-campaign",
    "status": "published",
    "title": "Summer Campaign",
    "type": "Form",
    "created_at": "2026-01-20T08:00:00.000+00:00",
    "form": {
      "id": "f2Kd8",
      "name": "Contact form",
      "created_at": "2026-01-15T10:00:00.000+00:00",
      "fields": [
        {
          "id": "ff1Ab",
          "type": "email",
          "label": "Email",
          "position": 0
        }
      ]
    }
  }
}
The show response includes the nested form with fields. See Forms for form field structure.

​
Errors

StatusWhen
401Missing or invalid token
403Missing scope, subscription, or company access
404Activation not found