---
title: "CloudObjectFolders.get"
method: GET
path: "/entities/CloudObjectFolders/{id}"
tags: ["Document"]
---

# CloudObjectFolders.get

`GET /entities/CloudObjectFolders/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/CloudObjectFolders/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/CloudObjectFolders/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the CloudObjectFolder record with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `expand` string

## Response `200`

The CloudObjectFolder record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` CloudObjectFolder: Folder that organizes files, either in the company documents or within a record.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `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. Related OnlineFormType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OnlineFormType' for its fields.
    - `parent_cloud_object_folder` string, uri: Parent folder, when this folder is nested. Empty for top-level folders. Related CloudObjectFolder record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CloudObjectFolder' for its fields.
    - `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: Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only. 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.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)