GET Folders Select List

Overview

---

The following table contains important information about the GET method in regards to retrieving a select list of folders. This endpoint can be scoped to the current project, a configurable set of projects (used by playlist scoping), or all projects in the organization.

GET Folders Select List
Method	GET
URL or Endpoint	/api/projects/projectId/folders/select-list
Headers	Authorization
Parameters	projectId, includeProjects, includeAllProjects
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Description
includeProjects	No	array[string]	List of project public IDs whose folders should be included in the select list. Use this to scope folder selection to a configurable set of projects (for example, the projects selected in a playlist's project scope). Ignored when includeAllProjects is set to true.
includeAllProjects	No	boolean	When true, returns folders from every project the caller has access to in the organization. When false (default), the result is limited to the current project plus any projects listed in includeProjects.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "parentId": 0,
      "projectId": "{projectId}",
      "id": 0,
      "name": "{name}",
      "value": "{value}",
      "description": "{description}"
    }
  ],
  "resultInfo": "{resultInfo}",
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Top-Level Properties

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from back-end.
result	array[object]	Returns the list of folder select-list items. See result Properties below.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

result Properties

Field Name	Type	Description
parentId	integer or null	Identifier of the parent folder, or null when the folder is at the root of its project.
projectId	string	Public identifier of the project that owns the folder. Useful when the result spans multiple projects (when includeProjects or includeAllProjects is used).
id	integer	Unique identifier of the folder.
name	string	Display name of the folder.
value	string	Select-list value associated with the folder.
description	string	Optional description of the folder.

If the action is successful, the service sends back an HTTP 200 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed