For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fetch Experience List

get

Retrieve a paginated list of experiences.

The response includes experiencesList plus the pagination fields page, limit, total, and totalPages.

Query Parameters

All query parameters are optional.

  • limit — integer, defaults to 20

  • page — integer (minimum 1), defaults to 1

  • status — one of started, paused, ended, pending

  • category — one of experiment, personalization

  • module — filter by modification type, one of content, checkout, postPurchase, pricing, merchandising, shipping. Category-agnostic; omit to return all modules.

offset is not supported for this endpoint. Pagination is page-based (page + limit).

Each list item includes history — raw user-action records with broad action types (saveExperience, duplicateExperience, archiveCampaign, etc.) and full user objects.

List items also include experienceActions for lifecycle-only events (start, pause, end, delete, reset), but on this endpoint each entry carries only id, experienceId, action, and actionTsthe performedBy email is not resolved here. To get the performing user's email, call GET /experiences/{experienceId}, whose experienceActions entries include performedBy. For config-deploy diffs, see ?includeChangeLog=true on GET /experiences/{experienceId}.

Field differences vs GET /experiences/{experienceId}

List items omit: experienceCustomMetrics, experienceIntegrations, experienceKeyMetrics, shippingTestMethodDefinitions, and shippingCarrierProvider.

List items additionally include: hasSchedule and history, neither of which appears on the single-experience response. hasSchedule is a boolean flag only — the external API never returns the schedules themselves, and includeSchedules is not an accepted query parameter here (it is ignored if sent).

variations is present on both, but list items carry a reduced variation shape.

Query parameters
categorystring · enumOptional

Filter by experience category. Omit to return all categories.

Possible values:
modulestring · enumOptional

Filter by modification type / module (content, checkout, postPurchase, pricing, merchandising, shipping). Category-agnostic. Omit to return all modules.

Possible values:
statusstring · enumOptional

Filter by lifecycle status. Omit to return all statuses.

Possible values:
limitinteger · min: 1 · max: 9007199254740991Optional

Maximum number of experiences per page.

pageinteger · min: 1 · max: 9007199254740991Optional

1-based page number for paginated results.

Responses
200

OK

application/json
get/v25-10-beta/experiences-list
200

OK

Last updated

Was this helpful?