Skip to content

List features

The features.list operation: GET /api/v1/features in the REST API and the features_list tool in the MCP server.

GET/api/v1/features

Lists the brand's features in the request's mode, newest first. Filter with key to find one feature.

Paginate with limit (1–100, default 10) and starting_after (the next_cursor of the previous page).

At a glance

  • REST: GET /api/v1/features
  • MCP tool: features_list
  • Operation ID: features.list
  • Scope: Brand
  • Permission: catalog:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Pagination: limit (at most 100) and starting_after
  • Authentication: API key with the catalog:read scope
  • Since: M4

Request

Query parameters

FieldTypeRequiredDescription
keystringNoOnly the feature with this key.
limitinteger (1 to 100)No
starting_afterfeat_… IDNo

Response

200 OK with a JSON object, a page of the list (newest first):

FieldTypeDescription
object"list"
dataarray of object
data[].idfeat_… ID
data[].object"feature"
data[].brandIdbrd_… ID
data[].livemodeboolean
data[].keystring
data[].namestring
data[].typeone of boolean, limit, enum
data[].enumValuesarray of string or null
data[].combineone of max, sum, or, first
data[].defaultValueboolean or number or string
data[].perUnitbooleanLimit features only: values are multiplied by the item's or purchase's quantity (spec §36.1).
data[].createdAtdate-time
data[].updatedAtdate-time
has_moreboolean
next_cursorfeat_… ID or null

Examples

The brand's features

HTTP
GET /api/v1/features
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "list",
  "data": [
    {
      "id": "feat_01m4tx5nj8emwbyf7y9vcf47y6",
      "object": "feature",
      "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
      "livemode": false,
      "key": "seats.max",
      "name": "Seats",
      "type": "limit",
      "enumValues": null,
      "combine": "max",
      "defaultValue": 1,
      "perUnit": true,
      "createdAt": "2026-10-13T12:00:00.000Z",
      "updatedAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A filter or pagination value is malformed.Fix the fields listed in details.issues and send the request again.
permission_denied403You can't see this brand's catalog.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, scope_required, resource_not_found, dry_run_not_supported, rate_limited, internal_error.