List attribute configurations

Returns a paginated list of attribute configurations — the memberships of attributes in attribute sets.

Filter by attribute, attribute set, attribute key, or attribute set name. Order with the sort parameter and page through the results with page and limit.

get

/attribute_config/

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

attributeintegerOptional

Filter by the identifier of the attribute.

attribute_setintegerOptional

Filter by the identifier of the attribute set.

attribute__keystringOptional

Filter by the key of the attribute.

attribute_set__namestringOptional

Filter by the name of the attribute set.

Responses

200

A paginated list of attribute configurations.

application/json

A page of attribute configuration results.

countintegerOptional

The total number of attribute configurations 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/attribute_config/

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 7001,
      "attribute": 42,
      "attribute_set": 15,
      "is_required": true,
      "is_visible": null,
      "is_searchable": null,
      "is_filterable": true,
      "is_variant": null,
      "is_variant_listable": null,
      "is_form_required": null,
      "is_form_field_required": null,
      "default_fields": [
        "is_visible",
        "is_searchable",
        "is_variant",
        "is_variant_listable",
        "is_form_required",
        "is_form_field_required"
      ],
      "order": 0,
      "attribute_config_group": null
    }
  ]
}