List attributes for an application
Retrieves a paginated list of attributes for a given application ID. Supports filtering by template key and searching by attribute name.
GET
/api/v1/{app_id}/attributes- API
- Auth
- OpenAPI
- auth-api
- Updated
- Apr 26, 2026
auth-api:GET:/api/v1/{app_id}/attributes
Retrieves a paginated list of attributes for a given application ID. Supports filtering by template key and searching by attribute name.
API ownership
- API family: Auth API
- Best for: Customer identity, session, token, cart, and wishlist flows.
- Do not use from: Merchant admin data syncs or public catalog rendering.
- Guide route: /apis/auth/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
Operation
- Method:
GET - Path:
/api/v1/\{app_id\}/attributes - Summary: List attributes for an application
- Description: Retrieves a paginated list of attributes for a given application ID. Supports filtering by template key and searching by attribute name.
- OpenAPI contract: auth-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.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| app_id | path | Yes | string | Application ID |
| page | query | No | integer | Page number for pagination |
| per_page | query | No | integer | Number of items per page |
| template_key | query | No | string | Filter by attribute template key |
| search | query | No | string | Search term for attribute name |
Request body
Not documented in the OpenAPI contract.
Responses
| Status | Description | Content |
|---|---|---|
| 200 | A paginated list of attributes | application/json (object) |
| 400 | Invalid request parameters | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Paginated Attribute List
| Property | Type | Required | Details |
|---|---|---|---|
items | object[] | No | - |
page | integer | No | - |
page_size | integer | No | - |
total_items | integer | No | - |
total_pages | integer | No | - |
Attribute
| Property | Type | Required | Details |
|---|---|---|---|
description | string | No | - |
id | string | No | - |
key | string | No | - |
name | string | No | - |
template_key | string | No | - |
translations | object | No | - |
values | object | No | - |
Attribute Translations
| Property | Type | Required | Details |
|---|---|---|---|
description | object | No | - |
name | object | No | - |
Generated example (synthetic):
{
"items": [
{
"description": "string",
"id": "string",
"key": "string",
"name": "string",
"template_key": "string",
"translations": {
"description": {},
"name": {}
},
"values": {}
}
],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}400 - object
HTTP Error
| Property | Type | Required | Details |
|---|---|---|---|
code | enum(201, 403, 401, 500, 404, 400, 409) | No | - |
details | string[] | No | - |
extra_fields | object | No | - |
message | string | No | - |
Generated example (synthetic):
{
"code": 201,
"details": [
"string"
],
"extra_fields": {},
"message": "string"
}500 - object
HTTP Error
| Property | Type | Required | Details |
|---|---|---|---|
code | enum(201, 403, 401, 500, 404, 400, 409) | No | - |
details | string[] | No | - |
extra_fields | object | No | - |
message | string | No | - |
Generated example (synthetic):
{
"code": 201,
"details": [
"string"
],
"extra_fields": {},
"message": "string"
}Contract identity
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Auth API
- Method:
GET - Path:
/api/v1/\{app_id\}/attributes - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Attributes
- OpenAPI summary: List attributes for an application