Skip to main content
GET
/
clients
List clients
curl --request GET \
  --url https://api.sftpsync.io/clients \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "cl_123",
    "name": "Acme"
  }
]

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

Clients

​
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.