Skip to main content
GET
/
documents
/
browse
Browse documents
curl --request GET \
  --url https://api.sftpsync.io/documents/browse \
  --header 'x-api-key: <api-key>'
{
  "folders": [
    {
      "name": "<string>",
      "path": "<string>",
      "isPipelineProtected": true,
      "size": 123,
      "lastModified": "2023-11-07T05:31:56Z"
    }
  ],
  "files": [
    {
      "name": "<string>",
      "path": "<string>",
      "size": 123,
      "isPipelineProtected": true,
      "lastModified": "2023-11-07T05:31:56Z"
    }
  ],
  "breadcrumb": {
    "connectionId": "<string>",
    "segments": [
      "<string>"
    ]
  },
  "nextToken": "<string>"
}

Authorizations

x-api-key
string
header
required

Query Parameters

connectionId
string
required
path
string

Folder path relative to the connection root (empty = root).

token
string

Pagination token from a previous page.

Response

200 - application/json

One page of folders and files

folders
object[]
required
files
object[]
required
breadcrumb
object
required
nextToken
string

Token for the next page; omitted when exhausted.