Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
filestorage/drives

Retrieve Drive

Retrieve a Drive from any connected file storage service

get/filestorage/drives/{id}

Path parameters

idstring required

id of the drive you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original file storage service.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the drive

remote_created_atstring nullable required

When the third party s drive was created.

drive_urlstring nullable required

The url of the drive

field_mappingsobject nullable

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

idstring nullable

The UUID of the drive

remote_idstring nullable

The id of the drive in the context of the 3rd Party

remote_dataobject nullable

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

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

remote_cursorstring nullable

The cursor used for pagination with the 3rd party provider

Example response

{
  "name": "school",
  "remote_created_at": "2024-10-01T12:00:00Z",
  "drive_url": "https://example.com/school",
  "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",
  "remote_cursor": "next_page_token_123"
}