Public API: Resources

This page is the full map of the AvsB public API. It lists every endpoint, grouped by resource family. Each row shows the method, the path, and the scope it needs. A scope is a named permission on your token. It controls what the token can read or change.

A token holding every scope a row lists can call it. So can a token holding the wildcard admin:*.

Each family links to its own reference page. That page is where the real, verified request bodies, response shapes, and error examples live, in tabbed cURL, TypeScript, and Python. This page stays a map on purpose. Showing worked examples for all 139 endpoints here would either repeat itself constantly or run out of room to stay correct about each one.

This table is a snapshot, taken on 11 August 2026. A route shipped after that date will not show up here until this page is rebuilt. Need a list you can trust right now? Read it from the live document instead. See Getting the live document below.

Audiences

5 endpoints. Full request and response examples: Audiences.

Method	Path	Scope(s)
GET	`/api/v1/audiences`	`audiences:read`
POST	`/api/v1/audiences`	`audiences:write`
DELETE	`/api/v1/audiences/{audienceId}`	`audiences:write`
GET	`/api/v1/audiences/{audienceId}`	`audiences:read`
PATCH	`/api/v1/audiences/{audienceId}`	`audiences:write`

Audit logs

1 endpoint. Full request and response examples: Audit logs.

Method	Path	Scope(s)
GET	`/api/v1/audit-logs`	`audit:read`

Catalog

9 endpoints. Full request and response examples: Catalog.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/catalog`	`catalog:read`
PATCH	`/api/v1/projects/{projectId}/catalog`	`catalog:write`
GET	`/api/v1/projects/{projectId}/catalog/products`	`catalog:read`
POST	`/api/v1/projects/{projectId}/catalog/products`	`catalog:write`
DELETE	`/api/v1/projects/{projectId}/catalog/products/{sku}`	`catalog:write`
GET	`/api/v1/projects/{projectId}/catalog/products/{sku}`	`catalog:read`
PUT	`/api/v1/projects/{projectId}/catalog/products/{sku}`	`catalog:write`
POST	`/api/v1/projects/{projectId}/catalog/products/bulk`	`catalog:write`
POST	`/api/v1/projects/{projectId}/catalog/products/bulk/{ingestId}/commit`	`catalog:write`

Datasets

11 endpoints. Full request and response examples: Datasets.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/datasets`	`datasets:read`
POST	`/api/v1/projects/{projectId}/datasets`	`datasets:write`
DELETE	`/api/v1/projects/{projectId}/datasets/{datasetId}`	`datasets:write`
GET	`/api/v1/projects/{projectId}/datasets/{datasetId}`	`datasets:read`
PATCH	`/api/v1/projects/{projectId}/datasets/{datasetId}`	`datasets:write`
GET	`/api/v1/projects/{projectId}/datasets/{datasetId}/lookup`	`datasets:read`
GET	`/api/v1/projects/{projectId}/datasets/{datasetId}/versions`	`datasets:read`
POST	`/api/v1/projects/{projectId}/datasets/{datasetId}/versions`	`datasets:write`
DELETE	`/api/v1/projects/{projectId}/datasets/{datasetId}/versions/{versionId}`	`datasets:write`
POST	`/api/v1/projects/{projectId}/datasets/{datasetId}/versions/{versionId}/activate`	`datasets:write`
POST	`/api/v1/projects/{projectId}/datasets/{datasetId}/versions/{versionId}/commit`	`datasets:write`

Environments

6 endpoints. Full request and response examples: Environments.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/environments`	`projects:read`
POST	`/api/v1/projects/{projectId}/environments`	`projects:write`
DELETE	`/api/v1/projects/{projectId}/environments/{envId}`	`projects:write`
GET	`/api/v1/projects/{projectId}/environments/{envId}`	`projects:read`
PATCH	`/api/v1/projects/{projectId}/environments/{envId}`	`projects:write`
POST	`/api/v1/projects/{projectId}/environments/{envId}/publish`	`projects:write`

Exclusion groups

7 endpoints. Full request and response examples: Exclusion groups.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/exclusion-groups`	`experiments:read`
POST	`/api/v1/projects/{projectId}/exclusion-groups`	`experiments:write`
DELETE	`/api/v1/projects/{projectId}/exclusion-groups/{groupId}`	`experiments:write`
GET	`/api/v1/projects/{projectId}/exclusion-groups/{groupId}`	`experiments:read`
PATCH	`/api/v1/projects/{projectId}/exclusion-groups/{groupId}`	`experiments:write`
POST	`/api/v1/projects/{projectId}/exclusion-groups/{groupId}/experiments`	`experiments:write`
DELETE	`/api/v1/projects/{projectId}/exclusion-groups/{groupId}/experiments/{experimentId}`	`experiments:write`

Experiments

12 endpoints. Full request and response examples: Experiments.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/experiments`	`experiments:read`
POST	`/api/v1/projects/{projectId}/experiments`	`experiments:write`
DELETE	`/api/v1/projects/{projectId}/experiments/{experimentId}`	`experiments:write`
GET	`/api/v1/projects/{projectId}/experiments/{experimentId}`	`experiments:read`
PATCH	`/api/v1/projects/{projectId}/experiments/{experimentId}`	`experiments:write`
POST	`/api/v1/projects/{projectId}/experiments/{experimentId}/archive`	`experiments:write`
POST	`/api/v1/projects/{projectId}/experiments/{experimentId}/cancel-schedule`	`experiments:write`
POST	`/api/v1/projects/{projectId}/experiments/{experimentId}/launch`	`experiments:write`
POST	`/api/v1/projects/{projectId}/experiments/{experimentId}/pause`	`experiments:write`
POST	`/api/v1/projects/{projectId}/experiments/{experimentId}/schedule`	`experiments:write`
POST	`/api/v1/projects/{projectId}/experiments/{experimentId}/stop`	`experiments:write`
POST	`/api/v1/projects/{projectId}/experiments/{experimentId}/unarchive`	`experiments:write`

Flag attributes

5 endpoints. Full request and response examples: Flag attributes.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/flag-attributes`	`flags:read`
POST	`/api/v1/projects/{projectId}/flag-attributes`	`flags:write`
DELETE	`/api/v1/projects/{projectId}/flag-attributes/{attrId}`	`flags:write`
GET	`/api/v1/projects/{projectId}/flag-attributes/{attrId}`	`flags:read`
PATCH	`/api/v1/projects/{projectId}/flag-attributes/{attrId}`	`flags:write`

Flags

25 endpoints. Full request and response examples: Flags.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/flags`	`flags:read`
POST	`/api/v1/projects/{projectId}/flags`	`flags:write`
DELETE	`/api/v1/projects/{projectId}/flags/{flagId}`	`flags:write`
GET	`/api/v1/projects/{projectId}/flags/{flagId}`	`flags:read`
PATCH	`/api/v1/projects/{projectId}/flags/{flagId}`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/archive`	`flags:write`
PATCH	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/pause`	`flags:write`
GET	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules`	`flags:read`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules`	`flags:write`
DELETE	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/{ruleId}`	`flags:write`
GET	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/{ruleId}`	`flags:read`
PATCH	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/{ruleId}`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/{ruleId}/duplicate`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/{ruleId}/pause`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/{ruleId}/run`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/copy`	`flags:write`
PUT	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/rules/reorder`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/run`	`flags:write`
DELETE	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/schedule`	`flags:write`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/envs/{envId}/schedule`	`flags:write`
GET	`/api/v1/projects/{projectId}/flags/{flagId}/rules/{ruleId}/results`	`results:read`
GET	`/api/v1/projects/{projectId}/flags/{flagId}/rules/{ruleId}/results/compare`	`results:read`
POST	`/api/v1/projects/{projectId}/flags/{flagId}/unarchive`	`flags:write`
PUT	`/api/v1/projects/{projectId}/flags/{flagId}/variations`	`flags:write`

Integrations

2 endpoints. Full request and response examples: Integrations.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/integrations`	`integrations:read`
PUT	`/api/v1/projects/{projectId}/integrations`	`integrations:write`

Members

4 endpoints. Full request and response examples: Members.

Method	Path	Scope(s)
GET	`/api/v1/members`	`members:read`
POST	`/api/v1/members`	`members:write`
DELETE	`/api/v1/members/{userId}`	`members:write`
PATCH	`/api/v1/members/{userId}`	`members:write`

Metric bindings

5 endpoints. Full request and response examples: Metric bindings.

Method	Path	Scope(s)
GET	`/api/v1/metric-bindings`	`metrics:read`
POST	`/api/v1/metric-bindings`	`metrics:write`
DELETE	`/api/v1/metric-bindings/{metricBindingId}`	`metrics:write`
GET	`/api/v1/metric-bindings/{metricBindingId}`	`metrics:read`
PATCH	`/api/v1/metric-bindings/{metricBindingId}`	`metrics:write`

Metrics

7 endpoints. Full request and response examples: Metrics.

Method	Path	Scope(s)
GET	`/api/v1/metrics`	`metrics:read`
POST	`/api/v1/metrics`	`metrics:write`
DELETE	`/api/v1/metrics/{metricId}`	`metrics:write`
GET	`/api/v1/metrics/{metricId}`	`metrics:read`
PATCH	`/api/v1/metrics/{metricId}`	`metrics:write`
POST	`/api/v1/metrics/{metricId}/archive`	`metrics:write`
POST	`/api/v1/metrics/{metricId}/unarchive`	`metrics:write`

Orders

2 endpoints. Full request and response examples: Orders.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/orders`	`orders:read`
GET	`/api/v1/projects/{projectId}/orders/summary`	`orders:read`

Organization

1 endpoint. Full request and response examples: Organization.

Method	Path	Scope(s)
GET	`/api/v1/org`	`org:read`

Projects

6 endpoints. Full request and response examples: Projects.

Method	Path	Scope(s)
GET	`/api/v1/projects`	`projects:read`
POST	`/api/v1/projects`	`projects:write`
GET	`/api/v1/projects/{projectId}`	`projects:read`
PATCH	`/api/v1/projects/{projectId}`	`projects:write`
GET	`/api/v1/projects/{projectId}/allowed-origins`	`projects:read`
PUT	`/api/v1/projects/{projectId}/allowed-origins`	`projects:write`

Recommendations

10 endpoints. Full request and response examples: Recommendations.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/recommendations/merchandising-rules`	`recommendations:read`
POST	`/api/v1/projects/{projectId}/recommendations/merchandising-rules`	`recommendations:write`
DELETE	`/api/v1/projects/{projectId}/recommendations/merchandising-rules/{ruleId}`	`recommendations:write`
PATCH	`/api/v1/projects/{projectId}/recommendations/merchandising-rules/{ruleId}`	`recommendations:write`
GET	`/api/v1/projects/{projectId}/recommendations/recipes`	`recommendations:read`
POST	`/api/v1/projects/{projectId}/recommendations/recipes`	`recommendations:write`
DELETE	`/api/v1/projects/{projectId}/recommendations/recipes/{recipeId}`	`recommendations:write`
GET	`/api/v1/projects/{projectId}/recommendations/recipes/{recipeId}`	`recommendations:read`
PATCH	`/api/v1/projects/{projectId}/recommendations/recipes/{recipeId}`	`recommendations:write`
POST	`/api/v1/projects/{projectId}/recommendations/recipes/{recipeId}/run`	`recommendations:write`

Results

2 endpoints. Full request and response examples: Results.

Method	Path	Scope(s)
GET	`/api/v1/experiments/{experimentId}/results`	`results:read`
GET	`/api/v1/experiments/{experimentId}/results/compare`	`results:read`

Roles

5 endpoints. Full request and response examples: Roles.

Method	Path	Scope(s)
GET	`/api/v1/roles`	`roles:read`
POST	`/api/v1/roles`	`roles:write`
DELETE	`/api/v1/roles/{roleId}`	`roles:write`
GET	`/api/v1/roles/{roleId}`	`roles:read`
PATCH	`/api/v1/roles/{roleId}`	`roles:write`

Segments

5 endpoints. Full request and response examples: Segments.

Method	Path	Scope(s)
GET	`/api/v1/segments`	`segments:read`
POST	`/api/v1/segments`	`segments:write`
DELETE	`/api/v1/segments/{segmentId}`	`segments:write`
GET	`/api/v1/segments/{segmentId}`	`segments:read`
PATCH	`/api/v1/segments/{segmentId}`	`segments:write`

Webhooks

9 endpoints. Full request and response examples: Webhooks.

Method	Path	Scope(s)
GET	`/api/v1/projects/{projectId}/webhooks`	`webhooks:read`
POST	`/api/v1/projects/{projectId}/webhooks`	`webhooks:write`
DELETE	`/api/v1/projects/{projectId}/webhooks/{webhookId}`	`webhooks:write`
GET	`/api/v1/projects/{projectId}/webhooks/{webhookId}`	`webhooks:read`
PATCH	`/api/v1/projects/{projectId}/webhooks/{webhookId}`	`webhooks:write`
GET	`/api/v1/projects/{projectId}/webhooks/{webhookId}/deliveries`	`webhooks:read`
POST	`/api/v1/projects/{projectId}/webhooks/{webhookId}/deliveries/{deliveryId}/retry`	`webhooks:write`
POST	`/api/v1/projects/{projectId}/webhooks/{webhookId}/secret`	`webhooks:write`
POST	`/api/v1/projects/{projectId}/webhooks/{webhookId}/test`	`webhooks:write`

Getting the live document

The list above is a point-in-time snapshot. AvsB also publishes the real thing: a live OpenAPI 3.1 document. The server builds it from the same rules it uses to check every request, so it can never drift from what the API actually does.

Shell

curl https://app.avsb.cloud/api/openapi.json -o openapi.jsoncurl https://app.avsb.cloud/api/openapi.yaml -o openapi.yaml

Shell2 lines

Read OpenAPI Specification to import that document into Postman, Insomnia, or Bruno. The same page shows how to generate a client SDK in any language straight from the URL.

Next steps

OpenAPI SpecificationThe live, always-current OpenAPI 3.1 document, and how to generate a client from it.

AuthenticationService token creation, scopes, rotation, and revocation.

ConventionsResponse envelopes, status codes, idempotency, rate-limit headers, pagination, and versioning.