List attributes

Returns a paginated list of attributes. Only attributes that apply to products are returned.

Filter by attribute key, order with the sort parameter, and page through the results with page and limit.

get

/attributes/

Authorizations

AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Query parameters

pageintegerOptional

The page number to return.

Default: 1

limitintegerOptional

The number of items to return per page.

Default: 10

sortstringOptional

Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.

Example: -id

keystringOptional

Filter by exact attribute key.

Responses

200

A paginated list of attributes.

application/json

A page of attribute results.

countintegerOptional

The total number of attributes matching the query.

nextstring · nullableOptional

The URL of the next page of results, when available.

previousstring · nullableOptional

The URL of the previous page of results, when available.

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

get/attributes/

GET /api/remote/1/attributes/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 42,
      "key": "color",
      "name": "Color",
      "data_type": "dropdown",
      "default_value": null,
      "is_required": true,
      "is_visible": true,
      "is_searchable": true,
      "is_filterable": true,
      "is_variant": true,
      "is_variant_listable": true,
      "is_form_required": false,
      "is_form_field_required": false
    }
  ]
}