- Home
- Resources
- Net Folders
GET /net_folders
List the net folders that the authenticated user has access to.
The optional title
query parameter limits the results to the net folder with the specified name. Wildcards are not supported.
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
|
100 |
int |
description_format |
query |
The desired format for the children descriptions. Can be "html" or "text". |
text |
|
first |
query |
|
0 |
int |
title |
query |
The name of the net folder. |
|
|
GET /net_folders/library_entities
Search for entities by keyword.
Request Parameters
name |
type |
description |
default |
constraints |
binders |
query |
Whether to include binders in the results. |
true |
boolean |
count |
query |
The maximum number of results to return. |
100 |
int |
description_format |
query |
The desired format for the binder description. Can be "html" or "text". |
text |
|
files |
query |
Whether to include files in the results. |
true |
boolean |
first |
query |
The index of the first result to return. |
0 |
int |
folder_entries |
query |
Whether to include folder entries in the results. |
true |
boolean |
keyword |
query |
A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is
allowed but "keyword=*d" is not. |
|
|
parent_binder_paths |
query |
Whether to include the parent binder path with each entity. |
false |
boolean |
recursive |
query |
Whether to search the immediate folder (false) or all subfolders (true). |
false |
boolean |
replies |
query |
Whether to include replies in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief). |
application/xml |
searchResultList
(XML) |
GET /net_folders/recent_activity
List recently changed folder entries in Net Folders.
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
The maximum number of results to return. |
20 |
int |
description_format |
query |
The desired format for the folder entry description. Can be "html" or "text". |
text |
|
first |
query |
The index of the first result to return. |
0 |
int |
parent_binder_paths |
query |
Whether to include the parent binder path with each entry. |
false |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of RecentActivityEntry resources. |
application/xml |
searchResultList
(XML) |