Admin Catalog: Attributes

List attributes (datagrid parity)

Paginated, filterable, sortable attribute list mirroring the admin Catalog → Attributes datagrid.

get/catalog/attributes

Request

Query parameters

pageinteger
Example:1

Page number (1-based).

per_pageinteger
Example:10

Items per page (default 10, max 50).

idstring
Example:1

Filter by attribute ID — single integer or comma-separated list (e.g. "1" or "1,2").

codestring
Example:color

Partial attribute code match (SQL LIKE).

type'text' | 'textarea' | 'price' | 'boolean' | 'select' | 'multiselect' | 'datetime' | 'date' | 'image' | 'file' | 'checkbox'
Example:select

Exact attribute type filter.

admin_namestring
Example:Color

Partial admin name match (SQL LIKE).

is_required0 | 1
Example:1

Filter by is_required (0 or 1).

is_unique0 | 1

Filter by is_unique (0 or 1).

is_filterable0 | 1
Example:1

Filter by is_filterable (0 or 1).

is_configurable0 | 1

Filter by is_configurable (0 or 1).

is_visible_on_front0 | 1
Example:1

Filter by is_visible_on_front (0 or 1).

is_user_defined0 | 1
Example:1

Filter by is_user_defined (0 or 1).

value_per_locale0 | 1

Filter by value_per_locale (0 or 1).

value_per_channel0 | 1

Filter by value_per_channel (0 or 1).

localestring
Example:en

Locale code for translation resolution (e.g. "en").

sort'id' | 'code' | 'admin_name' | 'type' | 'position'
Example:id

Column to sort by.

order'asc' | 'desc'
Example:desc

Sort direction.

Response

Paginated list of attribute rows in the { data, meta } envelope.

Changes

No recorded changes to this operation across all 8 revisions of this API.