GET api/Folders?parentId={parentId}&page={page}&pageSize={pageSize}
Gets one page of the folders directly inside a folder.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| parentId |
The parent folder's ID. |
globally unique identifier |
Required |
| page |
Page number, starting at 1. |
integer |
Required |
| pageSize |
Results per page. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The folders.
Collection of Folder| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The folder ID. |
globally unique identifier |
None. |
| Name |
The folder's name. |
string |
None. |
| UrlName |
The folder's own part of its URL. |
string |
None. |
| UrlPath |
The folder's URL path on the sales site: its override path if it has one, otherwise the path built from its parents. |
string |
None. |
| Description |
Short description. |
string |
None. |
| WebCopy |
The public web copy, as HTML. |
string |
None. |
| Image |
The folder's image, or null. |
Image |
None. |
| TemplateFull |
HTML for a full page about the folder, from its display template. |
string |
None. |
| TemplateSummary |
HTML for a summary of the folder, from its display template. |
string |
None. |
| PerformanceId |
The performance this folder is, or is part of. |
globally unique identifier |
None. |
| ShowId |
The show this folder is, or is part of. |
globally unique identifier |
None. |
| VenueId |
The venue this folder is, or is at. |
globally unique identifier |
None. |
| SpaceId |
The space this folder is, or is in. |
globally unique identifier |
None. |
| GenreId |
The genre this folder is, or is in. |
globally unique identifier |
None. |
| ExtraData |
More data about the folder, by name. |
Dictionary of string [key] and Object [value] |
None. |
Response Formats
application/json, text/json
Sample not available.