> ## Documentation Index
> Fetch the complete documentation index at: https://docs.filefeed.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get client

> **Deprecated** — use `GET /connections/{id}` instead.



## OpenAPI

````yaml /api-reference/openapi.json get /clients/{id}
openapi: 3.0.3
info:
  title: FileFeed API
  version: '2026-05-25'
  description: >-
    Official FileFeed REST API for connections, pipelines, schemas, pipeline
    runs, webhooks, outbound uploads, documents, files, and notifications.
    Date-based API versioning is controlled by the `FileFeed-Version` request
    header (default `2024-09-01`; latest `2026-05-25`); this document describes
    the `2026-05-25` shape.
servers:
  - url: https://api.sftpsync.io
security:
  - ApiKeyAuth: []
tags:
  - name: Connections
  - name: Pipelines
  - name: Schemas
  - name: Pipeline Runs
  - name: Webhooks
  - name: Outbound Uploads
  - name: Documents
  - name: Files
  - name: Notifications
  - name: Clients (deprecated)
paths:
  /clients/{id}:
    get:
      tags:
        - Clients (deprecated)
      summary: Get client
      description: '**Deprecated** — use `GET /connections/{id}` instead.'
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        '404':
          $ref: '#/components/responses/NotFound'
      deprecated: true
components:
  schemas:
    Client:
      deprecated: true
      description: >-
        **Deprecated** — alias for [Connection](#schema/Connection). Removed
        when API version `2024-09-01` sunsets on 2027-05-25.
      allOf:
        - $ref: '#/components/schemas/Connection'
    Connection:
      type: object
      description: >-
        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.
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
            - SFTP
            - EMAIL
          description: Connection kind. Always present as of API version `2026-05-25`.
        sftpUsername:
          type: string
        useHostedSFTP:
          type: boolean
        awsUserName:
          type: string
          description: >-
            Server-generated SFTP username slug for a FileFeed-hosted
            connection. (Outbound uploads reference a connection by its
            human-readable `name`, not this slug.)
        awsPublicKey:
          type: string
        ipWhitelist:
          type: array
          items:
            type: string
        sftpServerDataId:
          type: string
        sftpServer:
          $ref: '#/components/schemas/SftpServerData'
        emailInbox:
          $ref: '#/components/schemas/EmailInbox'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - type
        - createdAt
        - updatedAt
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
        statusCode:
          type: integer
        error:
          type: string
    SftpServerData:
      type: object
      description: >-
        The SFTP server a connection is bound to. For a self-hosted connection,
        host/port/rootDirectory describe the customer endpoint FileFeed dials
        out to; for a hosted connection, the FileFeed-managed AWS Transfer
        server.
      properties:
        id:
          type: string
        name:
          type: string
        isAwsHosted:
          type: boolean
        host:
          type: string
        port:
          type: integer
        rootDirectory:
          type: string
          nullable: true
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - isAwsHosted
        - host
        - port
        - status
    EmailInbox:
      type: object
      description: >-
        Resolved inbox config for an EMAIL connection. Returned on
        `Connection.emailInbox`, present only when `type` = `EMAIL`.
      properties:
        inboundAddress:
          type: string
          description: Address mail is delivered to, e.g. feed-7t9w@in.filefeed.io.
        allowedSenders:
          type: array
          items:
            type: string
          description: Full emails or @domain.com patterns. Empty = allow all senders.
        allowedFormats:
          type: array
          items:
            type: string
            enum:
              - csv
              - xlsx
              - xls
              - json
              - xml
              - tsv
        subjectFilter:
          type: string
          nullable: true
          description: Case-insensitive subject substring filter. Null = no filter.
      required:
        - inboundAddress
        - allowedSenders
        - allowedFormats
        - subjectFilter
  responses:
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````