Skip to main content
GET
Get paginated list of style files

Headers

X-Delogue-Api
string

Query Parameters

StyleId
integer<int64>

Restricts results to files belonging to a single style.

FolderId
integer<int64>

Restricts results to files in a single folder.

FolderType
enum<string>

Restricts results to files whose folder is of the given category. Category of the folder the file lives in, which groups files by their purpose within the style.

Available options:
internalFiles,
communicationFiles,
userDefinedFiles,
artworkFiles,
measurementFiles
State
enum<string>

Restricts results to files in the given lifecycle state. Whether the file is currently active or has been deactivated.

Available options:
active,
inactive
ColorwayId
integer<int64>

Restricts results to files linked to the given colourway.

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.

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. 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.