Skip to main content
GET
/
files
/
json
Get a processed JSON file by name
curl --request GET \
  --url https://api.sftpsync.io/files/json \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {}
  ],
  "pagination": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "returned": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
clientName
string
required

The connection's display name the file belongs to.

​
fileName
string
required

File name, without extension.

​
pipelineId
string
required
​
offset
integer
​
limit
integer

Response

Processed JSON file content

When the stored file is a JSON array and offset/limit are supplied, a paginated envelope is returned; otherwise the raw parsed JSON is returned (pagination absent).

​
data
object[]
required
​
pagination
object