List application attributes

Retrieves all attributes for the current application with support for pagination, filtering by template keys, searching by name, and sorting by various fields.

GET/api/v1/{team_slug}/{app_slug}/attributes/values
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/attributes/values

Retrieves all attributes for the current application with support for pagination, filtering by template keys, searching by name, and sorting by various fields.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/attributes/values
  • Summary: List application attributes
  • Description: Retrieves all attributes for the current application with support for pagination, filtering by template keys, searching by name, and sorting by various fields.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters9 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
template_keyqueryNostring[]Filter attributes by template keys (e.g., template_key=color&template_key=size)
idqueryNostring[]Filter attributes by ID (e.g., id=uuid1&id=uuid2)
searchqueryNostringSearch term to filter attributes by name
sort-orderqueryNostringSort order. Should be one of ASC or DESC. Default DESC
sort-keyqueryNostringThe key to sort on. Can be one of name, created_at, updated_at, key. Default created_at
pagequeryNointegerPage number (default is 1)
per-pagequeryNointegerAmount of attributes per page. Minimum 1 and max 100 (default is 20)
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200A list of attributes with pagination detailsapplication/json (object)
400Invalid request (e.g., bad pagination parameters, invalid sort key)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Attribute List

PropertyTypeRequiredDetails
dataobject[]No-
successbooleanNo-
totalintegerNo-
total_pagesintegerNo-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
Attribute Translations
PropertyTypeRequiredDetails
descriptionobject[]No-
nameobject[]No-

Generated example (synthetic):

{
  "data": [
    {
      "created_at": "string",
      "description": "string",
      "filterable": false,
      "id": "string",
      "key": "string",
      "name": "string",
      "template_key": "string",
      "template_name": "string",
      "translatable": false,
      "translations": {
        "description": [],
        "name": []
      },
      "updated_at": "string",
      "values": {}
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/attributes/values
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Attributes
  • OpenAPI summary: List application attributes

List application attributes

# List application attributes Retrieves all attributes for the current application with support for pagination, filtering by template keys, searching by name, and sorting by various fields.
GET /api/v1/{team_slug}/{app_slug}/attributes/values
Purpose

Retrieves all attributes for the current application with support for pagination, filtering by template keys, searching by name, and sorting by various fields.

Required inputs

app_slug path team_slug path

Primary response

200 ยท A list of attributes with pagination details

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/attributes/values

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/attributes/values` - Summary: List application attributes - Description: Retrieves all attributes for the current application with support for pagination, filtering by template keys, searching by name, and sorting by various fields. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/attributes/values` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | template_key | query | No | string[] | Filter attributes by template keys (e.g., template_key=color&template_key=size) | | id | query | No | string[] | Filter attributes by ID (e.g., id=uuid1&id=uuid2) | | search | query | No | string | Search term to filter attributes by name | | sort-order | query | No | string | Sort order. Should be one of ASC or DESC. Default DESC | | sort-key | query | No | string | The key to sort on. Can be one of `name`, `created_at`, `updated_at`, `key`. Default `created_at` | | page | query | No | integer | Page number (default is 1) | | per-page | query | No | integer | Amount of attributes per page. Minimum 1 and max 100 (default is 20) | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | A list of attributes with pagination details | application/json (object) | | 400 | Invalid request (e.g., bad pagination parameters, invalid sort key) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Attribute List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `success` | boolean | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | No | - | ##### Attribute Translations | Property | Type | Required | Details | | --- | --- | --- | --- | | `description` | object[] | No | - | | `name` | object[] | No | - | **Generated example (synthetic):** ```json { "data": [ { "created_at": "string", "description": "string", "filterable": false, "id": "string", "key": "string", "name": "string", "template_key": "string", "template_name": "string", "translatable": false, "translations": { "description": [], "name": [] }, "updated_at": "string", "values": {} } ], "success": false, "total": 0, "total_pages": 0 } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/attributes/values` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/attributes/values` - OpenAPI tag: Attributes - OpenAPI summary: List application attributes