---
title: "CloudObjectFolders.list"
method: GET
path: "/entities/CloudObjectFolders"
tags: ["Document"]
---

# CloudObjectFolders.list

`GET /entities/CloudObjectFolders`

Returns all defined CloudObjectFolders

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

list of CloudObjectFolders

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` CloudObjectFolder[]
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `online_form_type` string, uri — Online form template this folder is associated with, when the folder stores form submissions. Relation to OnlineFormType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormType' object for properties.
    - `parent_cloud_object_folder` string, uri — Parent folder, when this folder is nested. Empty for top-level folders. Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties.
    - `entity_api_name` string — API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
    - `entity_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product
    - `name` string, required — Name of the entity and its default text representation.
    - `online_form_type_id` string, uuid — Id of the online form template, or empty when not associated with a form.
    - `parent_cloud_object_folder_id` string, uuid — Id of the parent folder, or empty for top-level folders.
    - `revision` integer — Revision when entity was lastly changed.
  - `page_info` object — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
    - `start_cursor` string — Start cursor of result set.
    - `end_cursor` string — End cursor of result set.
    - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it).
    - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it).

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)