# File storage API — Folders > Canonical URL: https://developers.apideck.com/apis/file-storage/reference#tag/Folders This document contains every operation on the `Folders` resource. --- # Create Folder > **File storage API** · `POST /file-storage/folders` > Canonical URL: https://developers.apideck.com/apis/file-storage/reference#tag/Folders/operation/foldersAdd Create Folder ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | ### Request Body _Required._ - `id` `string` — A unique identifier for an object. — example: `12345` - `name` `string` **required** — The name of the folder. — example: `Documents` - `description` `string` — Optional description of the folder. — example: `My Personal Documents` - `parent_folder_id` `string` **required** — The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. — example: `1234` - `drive_id` `string` — ID of the drive to create the folder in. — example: `1234` - `pass_through` `array of object` — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` `string` **required** — Identifier for the service to which this pass_through should be applied. - `operation_id` `string` — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` `object` — Simple object allowing any properties for direct extension. - `extend_paths` `array of object` — Array of objects for structured data modifications via paths. - `path` `string` **required** — JSONPath string specifying where to apply the value. — example: `$.nested.property` - `value` `any` **required** — The value to set at the specified path, can be any type. ### Responses #### 201 — Folders - `status_code` `integer` **required** — HTTP Response Status Code — example: `201` - `status` `string` **required** — HTTP Response Status — example: `Created` - `service` `string` **required** — Apideck ID of service provider — example: `undefined` - `resource` `string` **required** — Unified API resource name — example: `Folders` - `operation` `string` **required** — Operation performed — example: `add` - `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted. - `id` `string` **required** — The unique identifier of the resource — example: `12345` - `_raw` `object` — Raw response from the integration when raw=true query param is provided #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Get Folder > **File storage API** · `GET /file-storage/folders/{id}` > Canonical URL: https://developers.apideck.com/apis/file-storage/reference#tag/Folders/operation/foldersOne Get Folder ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | `string` | Yes | ID of the record you are acting upon. | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | | `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | ### Responses #### 200 — Folders - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `undefined` - `resource` `string` **required** — Unified API resource name — example: `Folders` - `operation` `string` **required** — Operation performed — example: `one` - `data` `object` **required** - `id` `string` — A unique identifier for an object. — example: `12345` - `downstream_id` `string` — The third-party API ID of original entity — example: `12345` - `name` `string` **required** — The name of the folder — example: `Documents` - `description` `string` — Optional description of the folder — example: `My Personal Documents` - `path` `string` — The full path of the folder (includes the folder name) — example: `/Personal/Documents` - `size` `integer` — The size of the folder in bytes — example: `1810673` - `downloadable` `boolean` — Whether the current user can download the contents of this folder - `owner` `object` - `id` `string` — ID of the owner — example: `12345` - `email` `string` — Email of the owner — example: `hello@apideck.com` - `name` `string` — Name of the owner — example: `Elon Musk` - `parent_folders` `array of object` **required** — The parent folders of the file, starting from the root - `id` `string` **required** — A unique identifier for an object. — example: `12345` - `name` `string` — The name of the folder — example: `Personal` - `parent_folders_complete` `boolean` — Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder - `custom_mappings` `object` — When custom mappings are configured on the resource, the result is included here. - `updated_by` `string` — The user who last updated the object. — example: `12345` - `created_by` `string` — The user who created the object. — example: `12345` - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` - `_raw` `object` — Raw response from the integration when raw=true query param is provided #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Delete Folder > **File storage API** · `DELETE /file-storage/folders/{id}` > Canonical URL: https://developers.apideck.com/apis/file-storage/reference#tag/Folders/operation/foldersDelete Delete Folder ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | `string` | Yes | ID of the record you are acting upon. | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | ### Responses #### 200 — Folders - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `undefined` - `resource` `string` **required** — Unified API resource name — example: `Folders` - `operation` `string` **required** — Operation performed — example: `delete` - `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted. - `id` `string` **required** — The unique identifier of the resource — example: `12345` - `_raw` `object` — Raw response from the integration when raw=true query param is provided #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Rename or move Folder > **File storage API** · `PATCH /file-storage/folders/{id}` > Canonical URL: https://developers.apideck.com/apis/file-storage/reference#tag/Folders/operation/foldersUpdate Rename or move Folder ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | `string` | Yes | ID of the record you are acting upon. | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | ### Request Body _Required._ - `id` `string` — A unique identifier for an object. — example: `12345` - `name` `string` — The name of the folder. — example: `Documents` - `description` `string` — Optional description of the folder. — example: `My Personal Documents` - `parent_folder_id` `string` — The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. — example: `1234` - `pass_through` `array of object` — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` `string` **required** — Identifier for the service to which this pass_through should be applied. - `operation_id` `string` — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` `object` — Simple object allowing any properties for direct extension. - `extend_paths` `array of object` — Array of objects for structured data modifications via paths. - `path` `string` **required** — JSONPath string specifying where to apply the value. — example: `$.nested.property` - `value` `any` **required** — The value to set at the specified path, can be any type. ### Responses #### 200 — Folders - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `undefined` - `resource` `string` **required** — Unified API resource name — example: `Folders` - `operation` `string` **required** — Operation performed — example: `update` - `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted. - `id` `string` **required** — The unique identifier of the resource — example: `12345` - `_raw` `object` — Raw response from the integration when raw=true query param is provided #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Copy Folder > **File storage API** · `POST /file-storage/folders/{id}/copy` > Canonical URL: https://developers.apideck.com/apis/file-storage/reference#tag/Folders/operation/foldersCopy Copy Folder ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | `string` | Yes | ID of the record you are acting upon. | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | | `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | ### Request Body _Required._ - `id` `string` — A unique identifier for an object. — example: `12345` - `name` `string` — The name of the folder. — example: `Documents` - `parent_folder_id` `string` **required** — The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. — example: `1234` - `pass_through` `array of object` — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` `string` **required** — Identifier for the service to which this pass_through should be applied. - `operation_id` `string` — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` `object` — Simple object allowing any properties for direct extension. - `extend_paths` `array of object` — Array of objects for structured data modifications via paths. - `path` `string` **required** — JSONPath string specifying where to apply the value. — example: `$.nested.property` - `value` `any` **required** — The value to set at the specified path, can be any type. ### Responses #### 200 — Folders - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `undefined` - `resource` `string` **required** — Unified API resource name — example: `Folders` - `operation` `string` **required** — Operation performed — example: `update` - `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted. - `id` `string` **required** — The unique identifier of the resource — example: `12345` - `_raw` `object` — Raw response from the integration when raw=true query param is provided #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) ---