Skip to main content
GET
List and search tools and folders

Authorizations

Authorization
string
header
required

Company secret API key.

Query Parameters

scope
enum<string>

level (default) lists one folder level; company is a flat list of every tool of the company.

Available options:
level,
company
types
string[]

Comma separated tool types: woku, nps, csat, ces.

q
string

Case and accent insensitive search over names and questions. A search is company-wide and also matches folder names.

Maximum string length: 100
sort
enum<string>
default:name
Available options:
name,
-name,
created,
-created
cursor
string

Opaque nextCursor of the previous page.

limit
number
default:50
Required range: 1 <= x <= 100
foldersLimit
number

Folders per page ("see more"). Omitted returns every folder of the level.

Required range: 1 <= x <= 100
foldersCursor
string

Opaque foldersNextCursor of a previous page. Returns only that page of folders, without tools.

createdFrom
string<date-time>

Only tools created on or after this date (ISO 8601).

createdTo
string<date-time>

Only tools created on or before this date (ISO 8601).

trackers
string[]

Tracker chips as name:value, repeatable (?trackers=TRR:00482&trackers=OC:2024, up to 10). A tool matches when it has every one: the tracker name is matched exactly, the value partially and ignoring case (482 also matches 00482). Like a search, it is company-wide and lists no folders. A chip without name or value is a 400.

folderId
string<ObjectId>

Folder whose direct content is listed. Omit for the root. Ignored when scope=company or when searching.

Response

200

Folders, tools and facets