SavedSearch

Saved searches allow the user to save frequent used searches. These can be organized in folders for easy access. The saved searches can also be referenced in widgets to display current status of PIM data.

Gets the specified saved search folder

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

folderUidstring · uuidRequired

The uid of the folder

Responses

200

OK

application/json

Model of the saved search folder

OwnerUserUidstring · nullableOptional

useruid of a potential owner

Createdstring · date-timeOptional

The created datetime in UTC time

LastModifiedstring · date-timeOptional

The last modified time in UTC time

CreatedBystring · nullableOptional

The userUid of the user who originally created the folder

LastModifiedBystring · nullableOptional

The userUid of the user who last modified the folder If recently created, this is the same as created by

Uidstring · uuidOptional

The Uid of the folder

ParentUidstring · uuid · nullableOptional

Uid of parent folder

Namestring · nullableOptional

Name of the folder

SortOrderinteger · int32Optional

Sortorder for folders

400

Bad Request

application/json

404

Not Found

application/json

get

/v1/savedsearchfolders/{folderUid}

HTTPcURLJavaScriptPython

GET /v1/savedsearchfolders/{folderUid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "OwnerUserUid": "text",
  "Created": "2026-03-18T12:44:06.703Z",
  "LastModified": "2026-03-18T12:44:06.703Z",
  "CreatedBy": "text",
  "LastModifiedBy": "text",
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "ParentUid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "SortOrder": 1
}

Get the specified saved search folders

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

application/json

Model of the saved search folder

OwnerUserUidstring · nullableOptional

useruid of a potential owner

Createdstring · date-timeOptional

The created datetime in UTC time

LastModifiedstring · date-timeOptional

The last modified time in UTC time

CreatedBystring · nullableOptional

The userUid of the user who originally created the folder

LastModifiedBystring · nullableOptional

The userUid of the user who last modified the folder If recently created, this is the same as created by

Uidstring · uuidOptional

The Uid of the folder

ParentUidstring · uuid · nullableOptional

Uid of parent folder

Namestring · nullableOptional

Name of the folder

SortOrderinteger · int32Optional

Sortorder for folders

400

Bad Request

application/json

post

/v1/savedsearchfolders/batch

HTTPcURLJavaScriptPython

POST /v1/savedsearchfolders/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

[
  {
    "OwnerUserUid": "text",
    "Created": "2026-03-18T12:44:06.703Z",
    "LastModified": "2026-03-18T12:44:06.703Z",
    "CreatedBy": "text",
    "LastModifiedBy": "text",
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "ParentUid": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "SortOrder": 1
  }
]

Gets all saved search folders

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

Model of the saved search folder

OwnerUserUidstring · nullableOptional

useruid of a potential owner

Createdstring · date-timeOptional

The created datetime in UTC time

LastModifiedstring · date-timeOptional

The last modified time in UTC time

CreatedBystring · nullableOptional

The userUid of the user who originally created the folder

LastModifiedBystring · nullableOptional

The userUid of the user who last modified the folder If recently created, this is the same as created by

Uidstring · uuidOptional

The Uid of the folder

ParentUidstring · uuid · nullableOptional

Uid of parent folder

Namestring · nullableOptional

Name of the folder

SortOrderinteger · int32Optional

Sortorder for folders

400

Bad Request

application/json

get

/v1/savedsearchfolders

HTTPcURLJavaScriptPython

GET /v1/savedsearchfolders HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "OwnerUserUid": "text",
    "Created": "2026-03-18T12:44:06.703Z",
    "LastModified": "2026-03-18T12:44:06.703Z",
    "CreatedBy": "text",
    "LastModifiedBy": "text",
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "ParentUid": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "SortOrder": 1
  }
]

Create a single saved search folder

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Used to create a new saved search folder

OwnerUserUidstring · nullableOptional

Uid of the owner of the saved search folder. If null, the folder is available to all users

Uidstring · uuidOptional

The Uid of the folder

ParentUidstring · uuid · nullableOptional

Uid of parent folder

Namestring · nullableOptional

Name of the folder

SortOrderinteger · int32Optional

Sortorder for folders

Responses

200

OK

No content

400

Bad Request

application/json

post

/v1/savedsearchfolders

HTTPcURLJavaScriptPython

POST /v1/savedsearchfolders HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "OwnerUserUid": "text",
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "ParentUid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "SortOrder": 1
}

No content

Updates a saved search folder

patch

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Model used to update saved search folder

Uidstring · uuidOptional

The Uid of the folder

ParentUidstring · uuid · nullableOptional

Uid of parent folder

Namestring · nullableOptional

Name of the folder

SortOrderinteger · int32Optional

Sortorder for folders

Responses

200

OK

No content

400

Bad Request

application/json

patch

/v1/savedsearchfolders

HTTPcURLJavaScriptPython

PATCH /v1/savedsearchfolders HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "ParentUid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "SortOrder": 1
}

No content

Deletes a saved search folder

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

folderUidstring · uuidRequired

the uid of the folder

Responses

200

OK

No content

400

Bad Request

application/json

delete

/v1/SavedSearchFolders/{folderUid}

HTTPcURLJavaScriptPython

DELETE /v1/SavedSearchFolders/{folderUid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a specific search

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

The uid of the saved search

Responses

200

OK

application/json

The saved search api model

Uidstring · uuidOptional

The uid of the saved search

Createdstring · date-timeOptional

The created time in UTC time

CreatedBystring · nullableOptional

The user who created the safe search

LastMofidiedstring · date-timeOptional

The last modified time in UTC time Same as created time if the saved search hasn't been modified

LastModifiedBystring · nullableOptional

The user who last modified the saved search Same as createdBy if the saved search hasn't been modified

OwnerUserUidstring · nullableOptional

Potential owner of the saved search

FailedCalculationCounterinteger · int32Optional

The number of times this saved search has failed

FailedMessagestring · nullableOptional

The message describing why this saved search has failed

Namestring · nullableOptional

Name of the saved search

SearchEntityTypeModelinteger · enumOptional

The type of saved search

• 1 = Category: Category type
• 2 = Product: Product type
• 3 = VariantGroup: VariantGroup type
• 4 = Variant: Variant type
• 5 = Asset: Asset type
• 6 = GlobalList: Globallist type

Possible values:

GlobalListUidstring · uuid · nullableOptional

Globallist uid of referencing globallist

FolderUidstring · uuid · nullableOptional

Folder id of the saved search

SortOrderinteger · int32Optional

Sortorder of the saved search

EnableTimelinebooleanOptional

Whether or not to enable the timeline

TimelineBusinessUnitsstring · uuid[] · nullableOptional

Business unit limitation for timeline calculation

400

Bad Request

application/json

404

Not Found

application/json

get

/v1/savedsearches/{uid}

HTTPcURLJavaScriptPython

GET /v1/savedsearches/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Created": "2026-03-18T12:44:06.703Z",
  "CreatedBy": "text",
  "LastMofidied": "2026-03-18T12:44:06.703Z",
  "LastModifiedBy": "text",
  "OwnerUserUid": "text",
  "FailedCalculationCounter": 1,
  "FailedMessage": "text",
  "Name": "text",
  "SearchEntityTypeModel": 1,
  "GlobalListUid": "123e4567-e89b-12d3-a456-426614174000",
  "FolderUid": "123e4567-e89b-12d3-a456-426614174000",
  "Query": {
    "BooleanOperator": 0,
    "QueryModelType": "text"
  },
  "SortOrder": 1,
  "ViewColumns": [
    {
      "FieldUid": "text",
      "Width": 1
    }
  ],
  "EnableTimeline": true,
  "TimelineBusinessUnits": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Deletes a saved search from the system

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

The id of the saved search to delete

Responses

200

OK

No content

400

Bad Request

application/json

delete

/v1/savedsearches/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/savedsearches/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a list of specific searches

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

application/json

The saved search api model

Uidstring · uuidOptional

The uid of the saved search

Createdstring · date-timeOptional

The created time in UTC time

CreatedBystring · nullableOptional

The user who created the safe search

LastMofidiedstring · date-timeOptional

The last modified time in UTC time Same as created time if the saved search hasn't been modified

LastModifiedBystring · nullableOptional

The user who last modified the saved search Same as createdBy if the saved search hasn't been modified

OwnerUserUidstring · nullableOptional

Potential owner of the saved search

FailedCalculationCounterinteger · int32Optional

The number of times this saved search has failed

FailedMessagestring · nullableOptional

The message describing why this saved search has failed

Namestring · nullableOptional

Name of the saved search

SearchEntityTypeModelinteger · enumOptional

The type of saved search

• 1 = Category: Category type
• 2 = Product: Product type
• 3 = VariantGroup: VariantGroup type
• 4 = Variant: Variant type
• 5 = Asset: Asset type
• 6 = GlobalList: Globallist type

Possible values:

GlobalListUidstring · uuid · nullableOptional

Globallist uid of referencing globallist

FolderUidstring · uuid · nullableOptional

Folder id of the saved search

SortOrderinteger · int32Optional

Sortorder of the saved search

EnableTimelinebooleanOptional

Whether or not to enable the timeline

TimelineBusinessUnitsstring · uuid[] · nullableOptional

Business unit limitation for timeline calculation

400

Bad Request

application/json

post

/v1/savedsearches/batch

HTTPcURLJavaScriptPython

POST /v1/savedsearches/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Created": "2026-03-18T12:44:06.703Z",
    "CreatedBy": "text",
    "LastMofidied": "2026-03-18T12:44:06.703Z",
    "LastModifiedBy": "text",
    "OwnerUserUid": "text",
    "FailedCalculationCounter": 1,
    "FailedMessage": "text",
    "Name": "text",
    "SearchEntityTypeModel": 1,
    "GlobalListUid": "123e4567-e89b-12d3-a456-426614174000",
    "FolderUid": "123e4567-e89b-12d3-a456-426614174000",
    "Query": {
      "BooleanOperator": 0,
      "QueryModelType": "text"
    },
    "SortOrder": 1,
    "ViewColumns": [
      {
        "FieldUid": "text",
        "Width": 1
      }
    ],
    "EnableTimeline": true,
    "TimelineBusinessUnits": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]

Gets all searches in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

The saved search api model

Uidstring · uuidOptional

The uid of the saved search

Createdstring · date-timeOptional

The created time in UTC time

CreatedBystring · nullableOptional

The user who created the safe search

LastMofidiedstring · date-timeOptional

The last modified time in UTC time Same as created time if the saved search hasn't been modified

LastModifiedBystring · nullableOptional

The user who last modified the saved search Same as createdBy if the saved search hasn't been modified

OwnerUserUidstring · nullableOptional

Potential owner of the saved search

FailedCalculationCounterinteger · int32Optional

The number of times this saved search has failed

FailedMessagestring · nullableOptional

The message describing why this saved search has failed

Namestring · nullableOptional

Name of the saved search

SearchEntityTypeModelinteger · enumOptional

The type of saved search

• 1 = Category: Category type
• 2 = Product: Product type
• 3 = VariantGroup: VariantGroup type
• 4 = Variant: Variant type
• 5 = Asset: Asset type
• 6 = GlobalList: Globallist type

Possible values:

GlobalListUidstring · uuid · nullableOptional

Globallist uid of referencing globallist

FolderUidstring · uuid · nullableOptional

Folder id of the saved search

SortOrderinteger · int32Optional

Sortorder of the saved search

EnableTimelinebooleanOptional

Whether or not to enable the timeline

TimelineBusinessUnitsstring · uuid[] · nullableOptional

Business unit limitation for timeline calculation

400

Bad Request

application/json

get

/v1/savedsearches

HTTPcURLJavaScriptPython

GET /v1/savedsearches HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Created": "2026-03-18T12:44:06.703Z",
    "CreatedBy": "text",
    "LastMofidied": "2026-03-18T12:44:06.703Z",
    "LastModifiedBy": "text",
    "OwnerUserUid": "text",
    "FailedCalculationCounter": 1,
    "FailedMessage": "text",
    "Name": "text",
    "SearchEntityTypeModel": 1,
    "GlobalListUid": "123e4567-e89b-12d3-a456-426614174000",
    "FolderUid": "123e4567-e89b-12d3-a456-426614174000",
    "Query": {
      "BooleanOperator": 0,
      "QueryModelType": "text"
    },
    "SortOrder": 1,
    "ViewColumns": [
      {
        "FieldUid": "text",
        "Width": 1
      }
    ],
    "EnableTimeline": true,
    "TimelineBusinessUnits": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]

Create a saved search in the system

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Model to create a new saved search in the api

Uidstring · uuidOptional

Unique id if the saved search

OwnerUserUidstring · nullableOptional

The user who owns the saved search. If null, saved search is available to all users

Namestring · nullableOptional

Name of the saved search

SearchEntityTypeModelinteger · enumOptional

The type of saved search

• 1 = Category: Category type
• 2 = Product: Product type
• 3 = VariantGroup: VariantGroup type
• 4 = Variant: Variant type
• 5 = Asset: Asset type
• 6 = GlobalList: Globallist type

Possible values:

GlobalListUidstring · uuid · nullableOptional

Globallist uid of referencing globallist

FolderUidstring · uuid · nullableOptional

Folder id of the saved search

SortOrderinteger · int32Optional

Sortorder of the saved search

EnableTimelinebooleanOptional

Whether or not to enable the timeline

TimelineBusinessUnitsstring · uuid[] · nullableOptional

Business unit limitation for timeline calculation

Responses

200

OK

No content

400

Bad Request

application/json

post

/v1/savedsearches

HTTPcURLJavaScriptPython

POST /v1/savedsearches HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 391

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "OwnerUserUid": "text",
  "Name": "text",
  "SearchEntityTypeModel": 1,
  "GlobalListUid": "123e4567-e89b-12d3-a456-426614174000",
  "FolderUid": "123e4567-e89b-12d3-a456-426614174000",
  "Query": {
    "BooleanOperator": 0
  },
  "SortOrder": 1,
  "ViewColumns": [
    {
      "FieldUid": "text",
      "Width": 1
    }
  ],
  "EnableTimeline": true,
  "TimelineBusinessUnits": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Update a saved search

patch

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Model to update a saved search in the api

Uidstring · uuidOptional

Unique id if the saved search

OwnerUserUidstring · nullableOptional

The user who owns the saved search. If null, saved search is available to all users

Namestring · nullableOptional

Name of the saved search

SearchEntityTypeModelinteger · enumOptional

The type of saved search

• 1 = Category: Category type
• 2 = Product: Product type
• 3 = VariantGroup: VariantGroup type
• 4 = Variant: Variant type
• 5 = Asset: Asset type
• 6 = GlobalList: Globallist type

Possible values:

GlobalListUidstring · uuid · nullableOptional

Globallist uid of referencing globallist

FolderUidstring · uuid · nullableOptional

Folder id of the saved search

SortOrderinteger · int32Optional

Sortorder of the saved search

EnableTimelinebooleanOptional

Whether or not to enable the timeline

TimelineBusinessUnitsstring · uuid[] · nullableOptional

Business unit limitation for timeline calculation

Responses

200

OK

No content

400

Bad Request

application/json

patch

/v1/savedsearches

HTTPcURLJavaScriptPython

PATCH /v1/savedsearches HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 391

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "OwnerUserUid": "text",
  "Name": "text",
  "SearchEntityTypeModel": 1,
  "GlobalListUid": "123e4567-e89b-12d3-a456-426614174000",
  "FolderUid": "123e4567-e89b-12d3-a456-426614174000",
  "Query": {
    "BooleanOperator": 0
  },
  "SortOrder": 1,
  "ViewColumns": [
    {
      "FieldUid": "text",
      "Width": 1
    }
  ],
  "EnableTimeline": true,
  "TimelineBusinessUnits": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content