View as Markdown
Box icon

Box ACTION

Get File Metadata

Retrieves metadata for a file (name, size, timestamps, path, and more). Optionally request specific fields. Use List File Versions for version history, or Download File for content. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run Get File Metadata from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "box-get-file-metadata",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    box: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Parent Folder",
    fileId: "File",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get File Metadata inputs
Property Type Description
folderId Parent Folder string
The parent folder of the file. Use 0 for the root folder. Use the List Folders action to retrieve folder IDs.
Optional Dynamic
fileId File string
The file to retrieve metadata for (e.g. 123456789). Use the List Folder Items action to retrieve file IDs.
Required Dynamic
fields Fields string[]
A comma-separated list of attributes to include in the response (e.g. id,type,name,size,created_at,modified_at). See available fields.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
box-get-file-metadata
Version
0.0.2
App
Box
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes