Read style files

When to use this. Style files are the documents attached to a single style (tech packs, artwork, and reference files) filed into that style’s folders. Use these endpoints to read a style’s folders with their files, list files across the organisation with filters, and fetch a single file with its download URL and thumbnails. Adding and editing style files is not yet part of the public API.

The workflow

A style file wraps an uploaded file resource and places it in one of the style’s folders. You read files back in one of two shapes: folder by folder for a single style, or as a flat list you can filter across every style in the organisation.

Read a style's folders

GET /api/styles/{styleId}/files returns the style’s folders, each with its files embedded. Communication, measurement and artwork folders are left out unless you ask for them with folder-type (repeat the parameter for several types), and internal folders are left out unless you pass include-internal=true.

List and filter files

GET /api/style-files returns a flat, paginated list of style files across the organisation. Filter by styleId, folderId, folderType, state or colorwayId, and sort by id or name (by name when you do not choose). Page with pageSize and pageNumber, or with the cursor from the previous response.

Fetch a single file

GET /api/style-files/{id} returns one file by its id, with its folder, colourway link, download url and thumbnails.

Walkthrough

Read a style’s folders with their files embedded. Only the default folder types come back; add folder-type to include communication, measurement or artwork folders.

curl "https://service.my.delogue.com/api/styles/8815/files" \
  -H "Accept: application/json" \
  -H "X-Auth-Token: Bearer YOUR_API_KEY"

const res = await fetch("https://service.my.delogue.com/api/styles/8815/files", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-Auth-Token": "Bearer YOUR_API_KEY",
  },
});
const { data } = await res.json();

{
  "status": "success",
  "code": "style_file_folders_retrieved",
  "data": [
    {
      "id": 610,
      "name": "Style files",
      "folderType": "userDefinedFiles",
      "properties": [],
      "files": [
        {
          "id": 4821,
          "name": "tech-pack.pdf",
          "note": "Rev B: updated pocket placement",
          "state": "active",
          "properties": [],
          "url": "https://files.example.com/styles/SS26-1042/tech-pack.pdf",
          "position": 0,
          "thumbnails": [],
          "folderId": 610,
          "folderType": "userDefinedFiles",
          "colorwayId": null,
          "colorwayName": null,
          "createdOn": "2026-02-03T09:12:00Z",
          "createdBy": {
            "id": "5c1e7a42-8d3b-4f60-b2a9-1e4d7c0f9a35",
            "name": "Maja Holm"
          }
        },
        {
          "id": 4822,
          "name": "front-artwork-sky-blue.png",
          "note": null,
          "state": "active",
          "properties": [],
          "url": "https://files.example.com/styles/SS26-1042/front-artwork-sky-blue.png",
          "position": 1,
          "thumbnails": [
            {
              "id": "9e2b4c71-3a5d-4f08-8c16-d7a0e3b5f294",
              "url": "https://files.example.com/styles/SS26-1042/front-artwork-sky-blue-200.png",
              "width": 200,
              "height": 200
            }
          ],
          "folderId": 610,
          "folderType": "userDefinedFiles",
          "colorwayId": 3307,
          "colorwayName": "Sky Blue",
          "createdOn": "2026-02-03T09:14:00Z",
          "createdBy": {
            "id": "5c1e7a42-8d3b-4f60-b2a9-1e4d7c0f9a35",
            "name": "Maja Holm"
          }
        }
      ]
    }
  ]
}

The response wraps the folders in the standard envelope. Each file reports its folderId, folderType, position, state, and, for colourway-specific files, its colorwayId and colorwayName.

Field reference

The fields that matter most when reading a style file:

Field	What it means at Delogue
`colorwayId` / `colorwayName`	The colourway the file is linked to, or `null` for both when the file is not specific to a colourway.
`createdBy`	The user who added the file to the style (`id`, `name`), or `null` when the record predates user tracking.
`folderId` / `folderType`	The folder that holds the file, and that folder’s category: `internalFiles`, `communicationFiles`, `userDefinedFiles`, `artworkFiles` or `measurementFiles`.
`position`	Sort position of the file within its folder.
`properties`	Additive string flags. The only flag emitted today is `internal`, set when the file (or folder) is internal.
`state`	`active`, or `inactive` when the file has been deactivated.
`thumbnails`	Preview images for the file, each its own resource with a `url`, `width` and `height`. Empty when none has been generated or uploaded.
`url`	Download URL of the file’s underlying resource, or `null` when no resource is attached.

Roles & permissions

Reading style files requires read access under the styles permission: style files are part of the style, not a separate library. Every request is scoped to the caller’s organisation: a style or file that belongs to another organisation returns 403, and one that does not exist returns 404. GET /api/style-files/{id} checks the permission before it looks the file up, so a caller without style read access receives 403 whether or not the file exists.

When things go wrong

Errors use the standard envelope (status: "error", a code, and error.details[]). See Errors & responses for the full list of codes and how to resolve them.

What to call next

Styles

Create and manage the styles that files are attached to.

List a style's folders

Read a style’s folders with files embedded: GET /api/styles/{styleId}/files.

List style files

Filter and page through files across styles: GET /api/style-files.

Authentication

How to get and send your X-Auth-Token API key.

Getting Started

Concepts

Guides

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next

Styles

List a style's folders

List style files

Authentication

​The workflow

​Walkthrough

​Field reference

​Roles & permissions

​When things go wrong

​What to call next

Styles

List a style's folders

List style files

Authentication

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next