OMomnisend
Form A/B Setups

Get a form A/B setup

Get a single form A/B setup by ID, including its main form, variant forms with their weights, status, lifecycle timestamps, and the auto-close policy configured when the test was started (if any).

Scopes: forms.read

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

get/form-ab-setups/{abSetupID}

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/form-ab-setups/{abSetupID}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: forms.read
    • or API key in header Authorization

Path parameters

abSetupIDstring required

Form A/B setup ID

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

Form A/B setup

createdAtstring

A/B setup creation timestamp (read-only)

enabledAtstring

A/B setup enable timestamp (read-only)

idstring

A/B setup unique identifier (read-only)

launchedAtstring

A/B setup launch timestamp (read-only)

status'enabled' | 'draft' | 'disabled'

A/B test status of a form. disabled is a launched A/B test that is currently paused.

updatedAtstring

A/B setup last update timestamp (read-only)

Example response

{
  "autoClose": {
    "endsAt": "2026-09-30T23:59:59Z",
    "stopOnSignificance": true
  },
  "createdAt": "2026-02-20T14:00:00Z",
  "enabledAt": "2026-03-01T09:00:00Z",
  "id": "683b1a2e3f4a5b6c7d8e9f00",
  "launchedAt": "2026-03-01T09:00:00Z",
  "mainForm": {
    "formID": "683b1a2e3f4a5b6c7d8e9f00",
    "name": "Newsletter Signup"
  },
  "updatedAt": "2026-03-10T14:00:00Z",
  "versions": [
    {
      "formID": "683b1a2e3f4a5b6c7d8e9f01",
      "name": "Variant A",
      "weight": 50
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.