filestorage/folders

Retrieve Folders

Retrieve Folders from any connected Filestorage software

get/filestorage/folders/{id}

Path parameters

idstring required

id of the folder you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original File Storage software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the folder

sizestring nullable required

The size of the folder

folder_urlstring nullable required

The url of the folder

descriptionstring required

The description of the folder

drive_idstring nullable required

The UUID of the drive tied to the folder

parent_folder_idstring nullable required

The UUID of the parent folder

shared_linkstring nullable required

The UUID of the shared link tied to the folder

permissionstring nullable required

The UUID of the permission tied to the folder

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the folder

remote_idstring nullable

The remote ID of the folder in the context of the 3rd Party

remote_dataobject nullable

The remote data of the folder in the context of the 3rd Party

created_atstring date-time nullable

The created date of the folder

modified_atstring date-time nullable

The modified date of the folder

Example response

{
  "name": "school",
  "size": "2048",
  "folder_url": "https://example.com/school",
  "description": "All things school related",
  "drive_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "parent_folder_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "shared_link": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "permission": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes

Changed in 4 of the 18 revisions of this API.407

  • ca213ae36b7f191See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ▲

      the response's property type changed from string to object, and format from date-time to no format for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to object, and format from date-time to no format for status

      response-property-type-changed

    • ○

      the endpoint scheme security bearer was added to the API

      api-security-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed