Get attribute template

GET

api

{team_slug}

{app_slug}

attributes

{attribute_template_key}

Error

A valid request URL is required to generate request examples

{
  "data": {
    "attributes": [
      {
        "created_at": "<string>",
        "description": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "template_name": "<string>",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "created_at": "<string>",
    "fields": [
      {
        "created_at": "<string>",
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "type": "<string>",
        "updated_at": "<string>"
      }
    ],
    "filterable": true,
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "resources": [
      "<string>"
    ],
    "translatable": true,
    "type": "<string>",
    "updated_at": "<string>"
  },
  "success": true,
  "details": [
    "<string>"
  ]
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Management API token, sent as Authorization: Bearer <token>.

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

Query Parameters

string

Search for attributes within a template

sort-order

string

Sort order. Should be one of ASC or DESC. Default DESC

sort-key

string

The key to sort on. Can be one of created_at, name and type (Default is created_at)

Response

Attributes template and corresponding attributes

data

object

required

Show child attributes

success

boolean

required

details

string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

Error

A valid request URL is required to generate request examples

{
  "data": {
    "attributes": [
      {
        "created_at": "<string>",
        "description": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "template_name": "<string>",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "created_at": "<string>",
    "fields": [
      {
        "created_at": "<string>",
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "type": "<string>",
        "updated_at": "<string>"
      }
    ],
    "filterable": true,
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "resources": [
      "<string>"
    ],
    "translatable": true,
    "type": "<string>",
    "updated_at": "<string>"
  },
  "success": true,
  "details": [
    "<string>"
  ]
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Query Parameters

Response