GET v1/assets/{environment}/{orgId}/file/search?text={text}&page={page}&itemsPerPage={itemsPerPage}&sort={sort}

Searches for all exact or partial occurrences of the text sent, files using file name as its search pattern. Note that "page" and "items per page" will always default to 0 for page, and 20 for items per page if no values are supplied or the values make no sense. Page is zero based where 0 = the first page. Calling logic should compare the amount of items return versus items per page to determine if the end of the search has been reached.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orgId

Org Id where to search for files and folders.

 integer

Required
environment

Variable used to identify the environment calling the web service, where org id is valid.

 string

Required
text

Text to search for.

 string

Required
page

Page number.

 integer

Default value is 0
itemsPerPage

Items per page.

 integer

Default value is 20
sort

Optional sorting direction, this can be Ascending, Descending, or default, default value is Default. Default is treated as, in the order records were created.

 SortOption

Default value is Default

Body Parameters

None.

Response Information

Resource Description

AssetSearchResult
NameDescriptionTypeAdditional information
items

Contains the list of items found in the search, this property will have an empty array if no items where found.

 Collection of AssetResultItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "items": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "url": "sample string 3",
      "size": "sample string 4",
      "dimensions": "sample string 5",
      "parent": "sample string 6",
      "path": "sample string 7",
      "notes": "sample string 8",
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "resultType": 0,
      "type": {
        "typeId": "sample string 1",
        "type": "sample string 3"
      },
      "modified": "2025-06-26T08:00:50.7981098-07:00"
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "url": "sample string 3",
      "size": "sample string 4",
      "dimensions": "sample string 5",
      "parent": "sample string 6",
      "path": "sample string 7",
      "notes": "sample string 8",
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "resultType": 0,
      "type": {
        "typeId": "sample string 1",
        "type": "sample string 3"
      },
      "modified": "2025-06-26T08:00:50.7981098-07:00"
    }
  ]
}