---
title: "List SFTP destinations"
method: GET
path: "/v6/sftp-destinations"
tags: ["SFTP Servers"]
---

# List SFTP destinations

`GET /v6/sftp-destinations`

Returns all SFTP destination connection profiles configured for the client.

## Query parameters

- `type` 'EXTERNAL' | 'LOCAL'
- `name` string
- `username` string
- `host` string
- `limit` integer
- `offset` integer

## Response `200`

Successful response

- SftpDestinationResponse[]
  - union
    - ExternalSftpDestinationResponse — External sftp destination response.
      - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `dropbox_path` string, required
      - `extole_key_id` string, required
      - `host` string, required
      - `id` string, required
      - `name` string, required
      - `partner_key_id` string, nullable, required
      - `port` integer, required
      - `type` 'EXTERNAL', required
      - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `username` string, required
      - `key_id` string, required
    - LocalSftpDestinationResponse — Extole local sftp destination response.
      - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `dropbox_path` string, required
      - `extole_key_id` string, required
      - `host` string, required
      - `id` string, required
      - `name` string, required
      - `partner_key_id` string, nullable, required
      - `port` integer, required
      - `type` 'LOCAL', required
      - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `username` string, required
      - `file_processing_enabled` boolean, required
      - `key_ids` string[], required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `415` — Unsupported Media Type
- `429` — Too Many Requests

---

[API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/revisions/c16e62e66755/schema)
