Skip to main content
GET
/
connections
/
{id}
Get connection
curl --request GET \
  --url https://api.sftpsync.io/connections/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sftpUsername": "<string>",
  "useHostedSFTP": true,
  "awsUserName": "<string>",
  "awsPublicKey": "<string>",
  "ipWhitelist": [
    "<string>"
  ],
  "sftpServerDataId": "<string>",
  "emailInbox": {
    "inboundAddress": "<string>",
    "allowedSenders": [
      "<string>"
    ],
    "allowedFormats": [],
    "subjectFilter": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Response

Connection

An SFTP / Email / API endpoint with its credentials. Canonical name as of API version 2026-05-25 (formerly Client). Credentials (sftpPassword / sftpPrivateKey / sftpPassphrase / awsPassword) are write-only and never returned in responses.

​
id
string
required
​
name
string
required
​
type
enum<string>
required

Connection kind. Always present as of API version 2026-05-25.

Available options:
SFTP,
EMAIL
​
workspaceId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
sftpUsername
string
​
useHostedSFTP
boolean
​
awsUserName
string

Server-generated slug ({name}-{workspace}). Used as clientName for outbound uploads.

​
awsPublicKey
string
​
ipWhitelist
string[]
​
sftpServerDataId
string
​
emailInbox
object

Resolved inbox config for an EMAIL connection. Returned on Connection.emailInbox, present only when type = EMAIL.