Get attribute template
Retrieves a single attribute template by key, including its field definitions, associated attributes, and their values. Supports searching and sorting of attributes within the template.
GET
/api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:GET:/api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}
Retrieves a single attribute template by key, including its field definitions, associated attributes, and their values. Supports searching and sorting of attributes within the template.
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/\{attribute_template_key\} - Summary: Get attribute template
- Description: Retrieves a single attribute template by key, including its field definitions, associated attributes, and their values. Supports searching and sorting of attributes within the template.
- 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.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| app_slug | path | Yes | string | App slug |
| team_slug | path | Yes | string | Team slug |
| search | query | No | string | Search for attributes within a template |
| 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 created_at, name and type (Default is created_at) |
Request body
Not documented in the OpenAPI contract.
Responses
| Status | Description | Content |
|---|---|---|
| 200 | Attributes template and corresponding attributes | application/json (object) |
| 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) |
| 401 | Unauthorized access | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Attribute Template Response
| Property | Type | Required | Details |
|---|---|---|---|
data | object | No | - |
details | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes |
success | boolean | No | - |
Attribute Template
| Property | Type | Required | Details |
|---|---|---|---|
attributes | object[] | No | - |
created_at | string | No | - |
fields | object[] | No | - |
filterable | boolean | No | - |
id | string | No | - |
key | string | No | - |
name | string | No | - |
resources | string[] | No | - |
source_app_id | string | No | - |
source_id | string | No | - |
translatable | boolean | No | - |
type | string | No | - |
updated_at | string | 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 Template Field
| Property | Type | Required | Details |
|---|---|---|---|
created_at | string | No | - |
id | string | No | - |
key | string | No | - |
name | string | No | - |
type | string | No | - |
updated_at | string | No | - |
{
"data": {
"attributes": [
{
"created_at": "string",
"description": "string",
"filterable": false,
"id": "string",
"key": "string",
"name": "string",
"template_key": "string",
"template_name": "string",
"translatable": false,
"translations": {
"description": null,
"name": null
},
"updated_at": "string",
"values": {}
}
],
"created_at": "string",
"fields": [
{
"created_at": "string",
"id": "string",
"key": "string",
"name": "string",
"type": "string",
"updated_at": "string"
}
],
"filterable": false,
"id": "string",
"key": "string",
"name": "string",
"resources": [
"string"
],
"source_app_id": "string",
"source_id": "string",
"translatable": false,
"type": "string",
"updated_at": "string"
},
"details": [
"string"
],
"success": false
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"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):
{
"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):
{
"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/\{attribute_template_key\} - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Attribute Templates
- OpenAPI summary: Get attribute template