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: All plans, including Free

Path parameters

Name	Type	Description
`company`	string	Company sqid

Query parameters

Name	Type	Description
`q`	string	Filter by title (substring match)
`page`	integer	Page 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

Field	Type	Description
`id`	string	Activation slug
`redirect_url`	string\|null	Post-submission redirect URL
`slug`	string	URL slug
`status`	string	Activation status
`title`	string	Display title
`type`	string	Human-readable activation type label
`created_at`	string	ISO 8601 timestamp

Errors

Status	When
`401`	Missing or invalid token
`403`	Missing scope, subscription, or company access

Show activation

Method: GET
Path: /api/v1/{company}/activations/{activation}
Scope: activations:read
Subscription: All plans, including Free

Path parameters

Name	Type	Description
`company`	string	Company sqid
`activation`	string	Activation 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

Status	When
`401`	Missing or invalid token
`403`	Missing scope, subscription, or company access
`404`	Activation not found

Authentication
Conventions — Activation form page — public URL patterns for the hosted form
Animo for AI agents — when and how to link activation forms
Forms
Webhooks — activations:subscribe scope

Start here

Reference

Endpoints

Activations

Activations

Overview

Endpoints

List activations

Path parameters

Query parameters

Response `200`

Response fields

Errors

Show activation

Path parameters

Query parameters

Response `200`

Errors

​Activations

​Overview

​Endpoints

​List activations

​Path parameters

​Query parameters

​Response 200

​Response fields

​Errors

​Show activation

​Path parameters

​Query parameters

​Response 200

​Errors

​Related

Activations

Overview

Endpoints

List activations

Path parameters

Query parameters

Response `200`

Response fields

Errors

Show activation

Path parameters

Query parameters

Response `200`

Errors

Related