---
title: "Find File/Folder by Path"
method: GET
path: "/file_actions/metadata/{path}"
tags: ["file_actions", "Files"]
---

# Find File/Folder by Path

`GET /file_actions/metadata/{path}`

Find File/Folder by Path

## Path parameters

- `path` string, required

## Query parameters

- `preview_size` string
- `with_previews` boolean
- `with_priority_color` boolean

## Response `200`

The FileActions object.

- FileEntity — FileEntity model
  - `path` string — File/Folder path
  - `created_by_id` integer — User ID of the User who created the file/folder
  - `created_by_api_key_id` integer — ID of the API key that created the file/folder
  - `created_by_as2_incoming_message_id` integer — ID of the AS2 Incoming Message that created the file/folder
  - `created_by_automation_id` integer — ID of the Automation that created the file/folder
  - `created_by_bundle_registration_id` integer — ID of the Bundle Registration that created the file/folder
  - `created_by_inbox_id` integer — ID of the Inbox that created the file/folder
  - `created_by_remote_server_id` integer — ID of the Remote Server that created the file/folder
  - `created_by_sync_id` integer — ID of the Sync that created the file/folder
  - `custom_metadata` object — Custom metadata map of keys and values. Limited to 32 keys, 256 characters per key and 1024 characters per value.
  - `display_name` string — File/Folder display name
  - `type` string — Type: `directory` or `file`.
  - `size` integer — File/Folder size
  - `created_at` string, date-time — File created date/time
  - `last_modified_by_id` integer — User ID of the User who last modified the file/folder
  - `last_modified_by_api_key_id` integer — ID of the API key that last modified the file/folder
  - `last_modified_by_automation_id` integer — ID of the Automation that last modified the file/folder
  - `last_modified_by_bundle_registration_id` integer — ID of the Bundle Registration that last modified the file/folder
  - `last_modified_by_remote_server_id` integer — ID of the Remote Server that last modified the file/folder
  - `last_modified_by_sync_id` integer — ID of the Sync that last modified the file/folder
  - `mtime` string, date-time — File last modified date/time, according to the server. This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
  - `provided_mtime` string, date-time — File last modified date/time, according to the client who set it. Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times. This allows Desktop<->Cloud syncing to preserve modified at times.
  - `crc32` string — File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
  - `md5` string — File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
  - `sha1` string — File SHA1 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
  - `sha256` string — File SHA256 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
  - `mime_type` string — MIME Type. This is determined by the filename extension and is not stored separately internally.
  - `region` string — Region location
  - `permissions` string — A short string representing the current user's permissions. Can be `r` (Read),`w` (Write),`d` (Delete), `l` (List) or any combination
  - `subfolders_locked?` boolean — Are subfolders locked and unable to be modified?
  - `is_locked` boolean — Is this folder locked and unable to be modified?
  - `download_uri` string — Link to download file. Provided only in response to a download request.
  - `direct_connection_info` DirectConnectionInfoEntity
    - `version` integer — Direct connection information schema version.
    - `server_name` string — TLS server name (SNI and Host header) for the Agent's direct transfer listener.
    - `addresses` string[] — Validated ip:port candidates that may be dialed over TCP+TLS for this transfer.
    - `direct_uri` string — Signed HTTPS URI for direct Agent transfer traffic.
    - `ca_pem` string — PEM-encoded CA certificate used to verify the Agent's direct transfer TLS certificate.
  - `priority_color` string — Bookmark/priority color of file/folder
  - `preview_id` integer — File preview ID
  - `preview` PreviewEntity
    - `id` integer — Preview ID
    - `status` string — Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
    - `download_uri` string — Link to download preview
    - `type` string — Preview type. Can be image, pdf, pdf_native, video, audio, or text
    - `size` string — Preview size

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Conflict
- `412` — Precondition Failed
- `422` — Unprocessable Entity
- `423` — Locked
- `429` — Too Many Requests

---

[API](https://skmtc.net/files/apis/files-com-api.md) · [All operations](https://skmtc.net/files/apis/files-com-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/files/files-com-api/revisions/c6d6f57e6da8/schema)