Assets

Assets are files that can be stored in the system and referenced on products, variants, categories and global list values. Assets uploaded to the system are assigned a URL based on the assets file name. Each image asset can be auto-scaled, cropped and formatted by adding parameters to the URL of the asset. Thus, you should only upload an image once in the highest quality you will need it and the system will take care of any scaling automatically. Assets are organized in folders, which can be nested within each other.

Get ids of all assets

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

Responseinteger · int32[]

get

/v1/assets/ids

HTTPcURLJavaScriptPython

GET /v1/assets/ids HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  100,
  101,
  102,
  103,
  104
]

Get an asset by its id

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

/v1/assets/{id}

HTTPcURLJavaScriptPython

GET /v1/assets/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Id": 2011,
  "Uid": "3c9f2413-994e-4275-8634-36afae12a559",
  "CurrentFileVersion": 1,
  "Created": "2025-11-04T21:40:48.3320927+00:00",
  "LastModified": "2025-11-04T21:40:48.3321352+00:00",
  "CreatedBy": "",
  "LastModifiedBy": "",
  "AssetTypeUid": "1047a572-5a7c-45a4-bc32-edf142444013",
  "IsPrivate": false,
  "FileSize": 2035566,
  "FileType": "image/png",
  "Extension": "png",
  "FileName": "struct-logo.png",
  "FolderUid": "b6ac49b4-e00f-4958-9284-78b13ff508ca",
  "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
  "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
  "Tags": [
    "logo",
    "brand"
  ],
  "BusinessUnits": []
}

Delete an asset by its id

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset to delete

Responses

200

OK

No content

400

Bad Request

application/json

delete

/v1/assets/{id}

HTTPcURLJavaScriptPython

DELETE /v1/assets/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Update an assets data

patch

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

Body

application/json

Model for updating an existing asset

AssetTypeUidstring · uuid | nullableOptional

The unique identifier of the asset type to change the asset to. This defines the asset's characteristics and available metadata fields.

FolderUidstring · uuid | nullableOptional

The unique identifier of the folder where the asset should be moved to.

WorkflowStateUidstring · uuid | nullableOptional

The unique identifier of the workflow state to move the asset to.

Tagsstring[] | nullableOptional

Collection of tags to replace the existing tags on the asset. Providing an empty list will remove all tags.

Responses

200

OK

No content

400

Bad Request

application/json

patch

/v1/assets/{id}

HTTPcURLJavaScriptPython

PATCH /v1/assets/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "AssetId": 20111,
  "UpdateModel": {
    "AssetTypeUid": "887a8161-b4bb-4542-8022-ddbb430e0a82",
    "FolderUid": "7d709340-bd87-4b1a-9b0f-aaa83f68252e",
    "WorkflowStateUid": "cf5bd77a-9471-4080-9cdc-18aec9023435",
    "Tags": [
      "logo",
      "brand"
    ],
    "BusinessUnits": null,
    "Values": {
      "Description": "Nice picture of the wild nature"
    }
  }
}

No content

Get a list of assets by their ids (max 1000)

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/v1/assets/batch

HTTPcURLJavaScriptPython

POST /v1/assets/batch HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

[
  {
    "Id": 2011,
    "Uid": "00000000-0000-0000-0000-000000000000",
    "CurrentFileVersion": 1,
    "Created": "2025-11-14T22:40:48.3517821+01:00",
    "LastModified": "2025-11-14T22:40:48.3517987+01:00",
    "CreatedBy": "Struct",
    "LastModifiedBy": "Struct",
    "AssetTypeUid": "4f96ef64-1094-492d-9709-684043d19dab",
    "IsPrivate": false,
    "FileSize": 2035566,
    "FileType": "image/png",
    "Extension": "png",
    "FileName": "struct-logo.png",
    "FolderUid": "d99ae87a-3d7d-437f-940a-4be43151961a",
    "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
    "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
    "Tags": [
      "logo",
      "brand"
    ],
    "BusinessUnits": []
  },
  {
    "Id": 2011,
    "Uid": "00000000-0000-0000-0000-000000000000",
    "CurrentFileVersion": 1,
    "Created": "2025-11-14T22:40:48.3518043+01:00",
    "LastModified": "2025-11-14T22:40:48.3518050+01:00",
    "CreatedBy": "Struct",
    "LastModifiedBy": "Struct",
    "AssetTypeUid": "b7aecaef-e743-4105-844c-7633a2cddca4",
    "IsPrivate": false,
    "FileSize": 2035566,
    "FileType": "image/png",
    "Extension": "png",
    "FileName": "struct-logo2.png",
    "FolderUid": "f4c6d3bc-dca3-4868-91f0-be4c38a779bd",
    "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
    "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
    "Tags": [
      "logo",
      "brand"
    ],
    "BusinessUnits": []
  },
  {
    "Id": 2011,
    "Uid": "00000000-0000-0000-0000-000000000000",
    "CurrentFileVersion": 1,
    "Created": "2025-11-14T22:40:48.3518079+01:00",
    "LastModified": "2025-11-14T22:40:48.3518086+01:00",
    "CreatedBy": "Struct",
    "LastModifiedBy": "Struct",
    "AssetTypeUid": "83738bc8-9508-4a84-8d3f-6573e78dd900",
    "IsPrivate": false,
    "FileSize": 2035566,
    "FileType": "image/png",
    "Extension": "png",
    "FileName": "struct-logo3.png",
    "FolderUid": "b9753939-edd9-4fc0-bb3c-ece2a21256d2",
    "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo3.png",
    "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo3.png",
    "Tags": [
      "logo",
      "brand"
    ],
    "BusinessUnits": []
  }
]

Get all file versions of an asset

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/assets/{id}/fileversions

HTTPcURLJavaScriptPython

GET /v1/assets/{id}/fileversions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Uid": "e6ab7000-74ee-4763-b64b-564547ec5fb8",
    "AssetUid": "548ec049-e577-4148-9bb4-1603af342b79",
    "AssetId": 2011,
    "FileExtension": "png",
    "FileType": "image/png",
    "FileSize": 2035566,
    "FileName": "struct-logo.png",
    "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
    "Version": 1,
    "Created": "2025-11-14T22:40:48.3577647+01:00",
    "CreatedBy": "Struct"
  },
  {
    "Uid": "a099a56a-4be5-49ab-9ace-1af83b9f18f1",
    "AssetUid": "a45f729e-8444-4135-8de4-375a1cf5e2f3",
    "AssetId": 2011,
    "FileExtension": "png",
    "FileType": "image/png",
    "FileSize": 2035566,
    "FileName": "struct-logo2.png",
    "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
    "Version": 1,
    "Created": "2025-11-14T22:40:48.3577803+01:00",
    "CreatedBy": "Struct"
  }
]

Create a new version of an asset file

post

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

Body

multipart/form-data

filestring · binaryRequired

Upload file

Responses

200

OK

application/json

Responsestring · uuid

400

Bad Request

application/json

post

/v1/assets/{id}/fileversions

HTTPcURLJavaScriptPython

POST /v1/assets/{id}/fileversions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

123e4567-e89b-12d3-a456-426614174000

Get asset file versions for a list of assets

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/v1/assets/batch/fileversions

HTTPcURLJavaScriptPython

POST /v1/assets/batch/fileversions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

[
  {
    "Uid": "b22c07fc-f835-4886-a7f5-ef127c250b21",
    "AssetUid": "36e497fd-9438-4d98-9f42-f3739acb20c6",
    "AssetId": 2011,
    "FileExtension": "png",
    "FileType": "image/png",
    "FileSize": 2035566,
    "FileName": "struct-logo.png",
    "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
    "Version": 1,
    "Created": "2025-11-14T22:40:48.3639626+01:00",
    "CreatedBy": "Struct"
  },
  {
    "Uid": "13d11ad1-6777-4d1f-a9fd-96513452c033",
    "AssetUid": "87dc426c-c51f-4089-bd26-acfd98b26381",
    "AssetId": 2011,
    "FileExtension": "png",
    "FileType": "image/png",
    "FileSize": 2035566,
    "FileName": "struct-logo2.png",
    "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
    "Version": 1,
    "Created": "2025-11-14T22:40:48.3639745+01:00",
    "CreatedBy": "Struct"
  }
]

Get assets from page and page size. Assets are sorted by the created date.

get

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

Page

Default: 1

pageSizeinteger · int32Optional

Pagesize

Default: 100

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/assets

HTTPcURLJavaScriptPython

GET /v1/assets HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Assets": [
    {
      "Id": 2011,
      "Uid": "00000000-0000-0000-0000-000000000000",
      "CurrentFileVersion": 1,
      "Created": "2025-11-14T22:40:48.3657902+01:00",
      "LastModified": "2025-11-14T22:40:48.3657935+01:00",
      "CreatedBy": "Struct",
      "LastModifiedBy": "Struct",
      "AssetTypeUid": "4c54bdc4-b0da-4588-8c6f-5b983816f0ba",
      "IsPrivate": false,
      "FileSize": 2035566,
      "FileType": "image/png",
      "Extension": "png",
      "FileName": "struct-logo.png",
      "FolderUid": "9758a106-ee20-4c06-9f2c-0e44d663148c",
      "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
      "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
      "Tags": [
        "logo",
        "brand"
      ],
      "BusinessUnits": []
    },
    {
      "Id": 2011,
      "Uid": "00000000-0000-0000-0000-000000000000",
      "CurrentFileVersion": 1,
      "Created": "2025-11-14T22:40:48.3657957+01:00",
      "LastModified": "2025-11-14T22:40:48.3657961+01:00",
      "CreatedBy": "Struct",
      "LastModifiedBy": "Struct",
      "AssetTypeUid": "09923c5c-23df-4d9c-8559-76677247d36a",
      "IsPrivate": false,
      "FileSize": 2035566,
      "FileType": "image/png",
      "Extension": "png",
      "FileName": "struct-logo2.png",
      "FolderUid": "4fdc2d5c-5ea5-4cb9-9acd-ab7f6ab2483b",
      "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
      "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
      "Tags": [
        "logo",
        "brand"
      ],
      "BusinessUnits": []
    },
    {
      "Id": 2011,
      "Uid": "00000000-0000-0000-0000-000000000000",
      "CurrentFileVersion": 1,
      "Created": "2025-11-14T22:40:48.3657977+01:00",
      "LastModified": "2025-11-14T22:40:48.3658014+01:00",
      "CreatedBy": "Struct",
      "LastModifiedBy": "Struct",
      "AssetTypeUid": "81b11290-b836-4ea0-9645-5e9d45ee34b4",
      "IsPrivate": false,
      "FileSize": 2035566,
      "FileType": "image/png",
      "Extension": "png",
      "FileName": "struct-logo3.png",
      "FolderUid": "1d7f9abc-5d5a-4693-9755-ad5d8b1d8f8e",
      "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo3.png",
      "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo3.png",
      "Tags": [
        "logo",
        "brand"
      ],
      "BusinessUnits": []
    }
  ],
  "CurrentPage": 1,
  "PageSize": 100,
  "Total": 3
}

Create a new asset

post

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

assetTypeUidstring · uuidOptional

Uid of asset type

folderUidstring · uuidOptional

Uid of folder

Body

multipart/form-data

filestring · binaryRequired

Upload file

Responses

201

Created

application/json

400

Bad Request

application/json

post

/v1/assets

HTTPcURLJavaScriptPython

POST /v1/assets HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

1

Update multiple assets' data

patch

Authorizations

ApiKey

AuthorizationstringRequired

Bodyobject[]

application/json

Update model for a batch of assets

AssetIdinteger · int32Optional

Uid of asset to update

Responses

200

OK

No content

patch

/v1/assets

HTTPcURLJavaScriptPython

PATCH /v1/assets HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 544

[
  {
    "AssetId": 20111,
    "UpdateModel": {
      "AssetTypeUid": "455a7f79-efa8-4e2b-ab82-610cfcd833ff",
      "FolderUid": "b47e84e6-b538-4ea3-a2a0-bb04a0bbcc5d",
      "WorkflowStateUid": "4af9885e-d3dc-4e5b-9805-6722b46ff7a4",
      "Tags": null,
      "BusinessUnits": null,
      "Values": {
        "Description": "Nice picture of the wild nature"
      }
    }
  },
  {
    "AssetId": 18863,
    "UpdateModel": {
      "AssetTypeUid": "e701944e-a3ad-40b0-bd26-4c5c362e3b7c",
      "FolderUid": "3266137c-8e2a-47b8-a59f-554b26298dda",
      "WorkflowStateUid": "8752f2ac-64d2-4d8d-9dfa-9c2b3df64a71",
      "Tags": [
        "logo",
        "brand"
      ],
      "BusinessUnits": null,
      "Values": {}
    }
  }
]

200

OK

No content

Get assets from a folder by its uid

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Uid of folder

Query parameters

pageinteger · int32Optional

Page

Default: 1

pageSizeinteger · int32Optional

Page size

Default: 100

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/assets/folders/{uid}/assets

HTTPcURLJavaScriptPython

GET /v1/assets/folders/{uid}/assets HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Assets": [
    {
      "Id": 2011,
      "Uid": "00000000-0000-0000-0000-000000000000",
      "CurrentFileVersion": 1,
      "Created": "2025-11-14T22:40:48.3710074+01:00",
      "LastModified": "2025-11-14T22:40:48.3710198+01:00",
      "CreatedBy": "Struct",
      "LastModifiedBy": "Struct",
      "AssetTypeUid": "9d019d5b-007f-4a04-b7b3-cfac304e7b00",
      "IsPrivate": false,
      "FileSize": 2035566,
      "FileType": "image/png",
      "Extension": "png",
      "FileName": "struct-logo.png",
      "FolderUid": "f868f2db-54dd-4f85-a327-127a4279d194",
      "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
      "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo.png",
      "Tags": [
        "logo",
        "brand"
      ],
      "BusinessUnits": []
    },
    {
      "Id": 2011,
      "Uid": "00000000-0000-0000-0000-000000000000",
      "CurrentFileVersion": 1,
      "Created": "2025-11-14T22:40:48.3710245+01:00",
      "LastModified": "2025-11-14T22:40:48.3710251+01:00",
      "CreatedBy": "Struct",
      "LastModifiedBy": "Struct",
      "AssetTypeUid": "dc78a99e-4664-4be4-97c4-154efb8ddafe",
      "IsPrivate": false,
      "FileSize": 2035566,
      "FileType": "image/png",
      "Extension": "png",
      "FileName": "struct-logo2.png",
      "FolderUid": "4d49c112-7ad9-42ef-bcf7-75db22e4d75e",
      "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
      "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo2.png",
      "Tags": [
        "logo",
        "brand"
      ],
      "BusinessUnits": []
    },
    {
      "Id": 2011,
      "Uid": "00000000-0000-0000-0000-000000000000",
      "CurrentFileVersion": 1,
      "Created": "2025-11-14T22:40:48.3710276+01:00",
      "LastModified": "2025-11-14T22:40:48.3710283+01:00",
      "CreatedBy": "Struct",
      "LastModifiedBy": "Struct",
      "AssetTypeUid": "bfef78bc-3559-415c-9589-dd0d054e9a4b",
      "IsPrivate": false,
      "FileSize": 2035566,
      "FileType": "image/png",
      "Extension": "png",
      "FileName": "struct-logo3.png",
      "FolderUid": "74445cf0-d2a6-4944-927c-187cda439484",
      "FileUrl": "https://assetsinternal.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo3.png",
      "CDNUrl": "https://assets.struct.com/tenantslug/41fe3113-cb0f-446b-ae29-1f00a64098e2/struct-logo3.png",
      "Tags": [
        "logo",
        "brand"
      ],
      "BusinessUnits": []
    }
  ],
  "CurrentPage": 1,
  "PageSize": 100,
  "Total": 3
}

Get attribute values for an asset

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

Query parameters

globalListValueReferencesOnlybooleanOptional

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

Default: false

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/assets/{id}/attributevalues

HTTPcURLJavaScriptPython

GET /v1/assets/{id}/attributevalues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "AssetId": 2011,
  "Values": {
    "Description": "Nice picture of the wild nature",
    "RelatedImages": [
      "2566",
      "5155",
      "5664"
    ]
  }
}

Get attribute values for multiple assets

post

No more than 5000 assets can be requested at a time.

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Define which assets to fetch data for and what data to fetch

AssetIdsinteger · int32[] | nullableOptional

Ids of assets to return

IncludeValuesinteger · enumOptional

Defines which attribute values to return

• 1 = All: Return all attribute values
• 2 = Scopes: Return values for scopes specified in request
• 3 = Aliases: Return values for attribute aliases specified in request
• 4 = ScopesAndAliases: Return values for attributes in specified scopes, plus values in the attributes specified by alias
• 5 = Uids: Return values for attribute uids specified in request

Possible values:

Scopesstring[] | nullableOptional

If IncludeValues is Scopes, define which scopes to return values for here

Aliasesstring[] | nullableOptional

If IncludeValues is Aliases, define aliases of the attributes to include values for

Uidsstring · uuid[] | nullableOptional

If IncludeValues is Uids, define uids of the attributes to include values for

LimitToCultureCodesstring[] | nullableOptional

Only return values for specific languages

LimitToSegmentsstring[] | nullableOptional

Only return values for specific dimension segments

GlobalListValueReferencesOnlybooleanOptional

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

FromTimestampstring · date-time | nullableOptional

Get attribute values back in time

Responses

200

OK

application/json

post

/v1/assets/batch/attributevalues

HTTPcURLJavaScriptPython

POST /v1/assets/batch/attributevalues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "AssetIds": [
    1
  ],
  "IncludeValues": 1,
  "Scopes": [
    "text"
  ],
  "Aliases": [
    "text"
  ],
  "Uids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "LimitToCultureCodes": [
    "text"
  ],
  "LimitToSegments": [
    "text"
  ],
  "GlobalListValueReferencesOnly": true,
  "FromTimestamp": "2025-12-08T09:38:51.034Z"
}

200

OK

[
  {
    "AssetId": 2011,
    "Values": {
      "Description": "Nice picture of the wild nature",
      "RelatedImages": "3013"
    }
  },
  {
    "AssetId": 54698,
    "Values": {
      "Description": "Apple Iphone 16 Pro used by influencer",
      "RelatedImages": [
        "5654",
        "789",
        "2589"
      ]
    }
  }
]

Get enrichment insights for an asset

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/assets/{id}/enrichmentinsights

HTTPcURLJavaScriptPython

GET /v1/assets/{id}/enrichmentinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "EnrichmentInsightSetupUid": "b9ab083f-d622-4eba-b273-4a9bf26a3a03",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "731a399b-f61c-48d4-b1c0-251a20d7125a",
    "EntityId": 1974035,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Get enrichment insights for multiple assets

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/v1/assets/batch/enrichmentsinsights

HTTPcURLJavaScriptPython

POST /v1/assets/batch/enrichmentsinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

[
  {
    "EnrichmentInsightSetupUid": "032609ad-0ed4-41f6-9b29-463dae53f642",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "032609ad-0ed4-41f6-9b29-463dae53f642",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Get insights for a batch of assets and a specific Enrichment Insight

post

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

enrichmentInsightUidstringRequired

Query parameters

enrichmentInsightUidstring · uuidOptional

Uid of enrichment insight to get for batch of assets

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

post

/v1/assets/batch/enrichmentinsights/{enrichmentInsightUid}

HTTPcURLJavaScriptPython

POST /v1/assets/batch/enrichmentinsights/{enrichmentInsightUid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

[
  {
    "EnrichmentInsightSetupUid": "ca71e1a2-ed43-4691-89ac-2bd12a30049d",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "ca71e1a2-ed43-4691-89ac-2bd12a30049d",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Enable or disable an enrichment insight for an asset

patch

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

enrichmentInsightSetupUidstring · uuidRequired

Uid of enrichment insight to toggle ignore for

ignorebooleanRequired

Indicate whether to ignore the insight for the given enrichment insight and asset

Responses

200

OK

No content

patch

/v1/assets/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}

HTTPcURLJavaScriptPython

PATCH /v1/assets/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Enable or disable an enrichment insight for a batch of assets

patch

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

enrichmentInsightSetupUidstringRequired

ignorestringRequired

Query parameters

enrichmentInsightSetupUidstring · uuidOptional

Uid of enrichment insight to toggle ignore for

ignorebooleanOptional

Indicate whether to ignore the insight for the given enrichment insight and assets

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

No content

patch

/v1/assets/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}

HTTPcURLJavaScriptPython

PATCH /v1/assets/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

No content

Get references to an asset

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of asset

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/assets/{id}/references

HTTPcURLJavaScriptPython

GET /v1/assets/{id}/references HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "AssetId": 12,
  "ReferencingCategories": [
    {
      "EntityId": 100,
      "AttributeUid": "cebdf890-acbc-4043-add4-a9b9a5ac1245"
    },
    {
      "EntityId": 101,
      "AttributeUid": "cebdf890-acbc-4043-add4-a9b9a5ac1245"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 100010,
      "AttributeUid": "14c85c92-0e33-4983-99f3-1fb76137c0b9"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "14c85c92-0e33-4983-99f3-1fb76137c0b9"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "c727cb65-5038-4489-8ddf-cf3fbf194293"
    }
  ],
  "ReferencingVariantGroups": [
    {
      "EntityId": 100,
      "AttributeUid": "c727cb65-5038-4489-8ddf-cf3fbf194293"
    }
  ],
  "ReferencingVariants": [
    {
      "EntityId": 100,
      "AttributeUid": "14c85c92-0e33-4983-99f3-1fb76137c0b9"
    }
  ],
  "ReferencingAssets": [
    {
      "EntityId": 100,
      "AttributeUid": "c727cb65-5038-4489-8ddf-cf3fbf194293"
    }
  ],
  "ReferencingGlobalListValues": [
    "b2579e22-48c6-4e05-a2c7-0055484c689b",
    "de155b7f-ba8b-4fae-97c2-b7bdab5236c7"
  ]
}

Get references to a batch of assets

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

post

/v1/assets/batch/references

HTTPcURLJavaScriptPython

POST /v1/assets/batch/references HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

[
  {
    "AssetId": 12,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "986aeba1-e5d0-4295-ae90-c8a6086feb52"
      },
      {
        "EntityId": 101,
        "AttributeUid": "986aeba1-e5d0-4295-ae90-c8a6086feb52"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 100010,
        "AttributeUid": "4e966463-f8d5-4354-9260-15e157b725f1"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "4e966463-f8d5-4354-9260-15e157b725f1"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "4c4b0e37-84df-4fe7-a3df-0d143225ea34"
      }
    ],
    "ReferencingVariantGroups": [
      {
        "EntityId": 100,
        "AttributeUid": "4c4b0e37-84df-4fe7-a3df-0d143225ea34"
      }
    ],
    "ReferencingVariants": [
      {
        "EntityId": 100,
        "AttributeUid": "4e966463-f8d5-4354-9260-15e157b725f1"
      }
    ],
    "ReferencingAssets": [
      {
        "EntityId": 100,
        "AttributeUid": "4c4b0e37-84df-4fe7-a3df-0d143225ea34"
      }
    ],
    "ReferencingGlobalListValues": [
      "4ab15d84-a44e-4025-9306-611f5c711d99",
      "a26107f7-5f5e-480c-a3ea-3aad3ff4f770"
    ]
  },
  {
    "AssetId": 20,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "986aeba1-e5d0-4295-ae90-c8a6086feb52"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 23553,
        "AttributeUid": "4e966463-f8d5-4354-9260-15e157b725f1"
      },
      {
        "EntityId": 5656,
        "AttributeUid": "4e966463-f8d5-4354-9260-15e157b725f1"
      }
    ],
    "ReferencingVariantGroups": [
      {
        "EntityId": 100,
        "AttributeUid": "4c4b0e37-84df-4fe7-a3df-0d143225ea34"
      }
    ],
    "ReferencingVariants": [
      {
        "EntityId": 568323,
        "AttributeUid": "4c4b0e37-84df-4fe7-a3df-0d143225ea34"
      }
    ],
    "ReferencingAssets": [
      {
        "EntityId": 100,
        "AttributeUid": "4c4b0e37-84df-4fe7-a3df-0d143225ea34"
      }
    ],
    "ReferencingGlobalListValues": [
      "ce203566-6b30-441e-bfc2-dc2bc52d61f1",
      "9ce0e669-e249-4919-a65c-0c9c9cc8b9c4"
    ]
  }
]

Get ids of assets matching a certain criteria

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Search model used for searching products or variants in PIM

IncludeArchivedbooleanOptional

Include archived items in result

Responses

200

OK

application/json

Responseinteger · int32[]

400

Bad Request

application/json

post

/v1/assets/search

HTTPcURLJavaScriptPython

POST /v1/assets/search HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "IncludeArchived": true,
  "QueryModel": {
    "BooleanOperator": 0
  }
}

[
  1
]

Get paged result of assets matching certain criteria. Result mapped with headers and item results

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Extended search model used for searching products or variants in PIM with support for paging and sorting

Pageinteger · int32Optional

PageSizeinteger · int32 | nullableOptional

FieldUidsstring[] | nullableOptional

SortByFieldUidstring | nullableOptional

SortDescendingboolean | nullableOptional

IncludeArchivedbooleanOptional

Include archived items in result

Responses

200

OK

application/json

400

Bad Request

application/json

post

/v1/assets/search/paged

HTTPcURLJavaScriptPython

POST /v1/assets/search/paged HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "Page": 1,
  "PageSize": 1,
  "FieldUids": [
    "text"
  ],
  "SortByFieldUid": "text",
  "SortDescending": true,
  "IncludeArchived": true,
  "QueryModel": {
    "BooleanOperator": 0
  }
}

{
  "TotalHits": 1,
  "Page": 1,
  "PageSize": 1,
  "TotalPages": 1,
  "ItemListHeaders": [
    {
      "FieldUid": "text",
      "FieldName": "text",
      "FieldType": "text",
      "SupportsSearching": true,
      "SupportsSorting": true
    }
  ],
  "ListItems": [
    {
      "Id": 1,
      "ShownValues": [
        "text"
      ]
    }
  ]
}

Get all available query fields for assets

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/assets/queryablefields

HTTPcURLJavaScriptPython

GET /v1/assets/queryablefields HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Uid": "text",
    "Name": "text",
    "SupportsSorting": true
  }
]