Skip to main content
GET
List style custom field definitions with filtering, sorting, and pagination.

Headers

X-Delogue-Api
string

Query Parameters

Free-text search matched against the field name and user-defined identifier.

Ids
integer<int64>[]

Restricts results to style custom fields with any of these identifiers.

Names
string[]

Restricts results to fields whose name exactly matches any of these values.

UserDefinedIds
string[]

Restricts results to fields whose user-defined identifier matches any of these values.

Types
enum<string>[]

Restricts results to fields of any of these field types.

Available options:
allowedValue,
date,
text,
nestedAllowedValue,
numeric,
divider
State
enum<string>

Restricts results to fields in this lifecycle state. Lifecycle state that determines whether the field is available for use on styles.

Available options:
active,
inactive,
deleted
IsMandatory
boolean

When set, restricts results to fields whose mandatory flag matches this value.

IsSupplierEditable
boolean

When set, restricts results to fields whose supplier-editable flag matches this value.

InternalOnly
boolean

When set, restricts results to fields whose internal-only flag matches this value.

BrandIds
integer<int64>[]

Restricts results to fields associated with any of these brand identifiers.

GroupIds
integer<int64>[]

Restricts results to fields associated with any of these style group identifiers.

StyleCategoryIds
integer<int64>[]

Restricts results to fields associated with any of these style category identifiers.

ParentCustomFieldId
integer<int64>

Restricts results to child fields whose parent custom field has this identifier.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, UserDefinedId, Position, Type.

pageSize

Number of results per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

Opaque keyset pagination token from a previous response. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.