List Files - Panora Documentation

GET

filestorage

files

import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.filestorage.files.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });
  
  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "name": "my_paris_photo.png",
      "file_url": "https://example.com/my_paris_photo.png",
      "mime_type": "application/pdf",
      "size": "1024",
      "folder_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "permission": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "shared_link": "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"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Headers

x-connection-token

string

required

The connection token

Query Parameters

remote_data

boolean

Set to true to include data from the original software.

limit

number

default:50

Set to get the number of records.

cursor

string

Set to get the number of records after this cursor.

Response

200 - application/json

prev_cursor

string | null

required

next_cursor

string | null

required

data

object[]

required

data.name

string | null

required

The name of the file

Example:

"my_paris_photo.png"

data.file_url

string | null

required

The url of the file

Example:

"https://example.com/my_paris_photo.png"

data.mime_type

string | null

required

The mime type of the file

Example:

"application/pdf"

data.size

string | null

required

The size of the file

Example:

"1024"

data.folder_id

string | null

required

The UUID of the folder tied to the file

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

data.permission

string | null

required

The UUID of the permission tied to the file

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

data.shared_link

string | null

required

The UUID of the shared link tied to the file

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

data.field_mappings

object | null

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

Example:

{
  "fav_dish": "broccoli",
  "fav_color": "red"
}

data.id

string | null

The UUID of the file

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

data.remote_id

string | null

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

Example:

"id_1"

data.remote_data

object | null

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

Example:

{
  "fav_dish": "broccoli",
  "fav_color": "red"
}

data.created_at

string | null

The created date of the object

Example:

"2024-10-01T12:00:00Z"

data.modified_at

string | null

The modified date of the object

Example:

"2024-10-01T12:00:00Z"

Was this page helpful?

Suggest edits Raise issue

Create Files Retrieve Files

import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.filestorage.files.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });
  
  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "name": "my_paris_photo.png",
      "file_url": "https://example.com/my_paris_photo.png",
      "mime_type": "application/pdf",
      "size": "1024",
      "folder_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "permission": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "shared_link": "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"
    }
  ]
}

File Storage Objects

Authorizations

Headers

Query Parameters

Response