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

# Get a sync flow step

> Returns the form definition for the requested step of a sync setup wizard (auth, target selection, secret mapping).



## OpenAPI

````yaml /api-reference/openapi.json get /v1/sync/{slug}/flow
openapi: 3.0.3
info:
  title: Enkryptify API
  version: 1.0.0
  description: >-
    REST API for Enkryptify. Manage secrets, projects, teams and workspaces.
    Authenticate with an `ek_live_` API token via the `Authorization: Bearer`
    header. See https://docs.enkryptify.com/api-reference/introduction.
servers:
  - url: http://localhost:8080
    description: Production
security: []
tags:
  - name: auth
    description: Token exchange and authentication for API access.
  - name: workspace
    description: Workspaces group your projects, teams and members.
  - name: project
    description: Projects organize secrets per application or service.
  - name: team
    description: Teams scope which members can access which projects.
  - name: secret
    description: Read, create, update and delete secret values.
  - name: secret-share
    description: Create and consume time-bound encrypted secret shares.
  - name: tokens
    description: Manage API tokens for programmatic access.
  - name: sync
    description: Manage integrations that sync secrets to external systems.
  - name: me
    description: Inspect the authenticated user, sessions and preferences.
  - name: oidc
    description: Workspace-scoped OpenID Connect identity federation.
paths:
  /v1/sync/{slug}/flow:
    get:
      tags:
        - sync
      summary: Get a sync flow step
      description: >-
        Returns the form definition for the requested step of a sync setup
        wizard (auth, target selection, secret mapping).
      operationId: getSyncFlowStep
      parameters:
        - schema:
            type: string
          in: query
          name: syncConfigId
          required: true
        - schema:
            type: string
          in: query
          name: step
          required: true
        - schema:
            type: string
            minLength: 2
            maxLength: 48
            pattern: ^[a-z0-9-]+$
          in: path
          name: slug
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  description:
                    type: string
                  fields:
                    type: array
                    items:
                      oneOf:
                        - type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                                - input
                            label:
                              type: string
                            data:
                              type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                    - text
                                    - password
                                placeholder:
                                  type: string
                                defaultValue:
                                  type: string
                                description:
                                  type: string
                                isRequired:
                                  type: boolean
                              required:
                                - type
                                - placeholder
                              additionalProperties: false
                          required:
                            - id
                            - type
                            - label
                            - data
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                                - select
                            label:
                              type: string
                            data:
                              type: object
                              properties:
                                placeholder:
                                  type: string
                                defaultValue:
                                  type: string
                                isRequired:
                                  type: boolean
                                description:
                                  type: string
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      label:
                                        type: string
                                      value:
                                        type: string
                                    required:
                                      - label
                                      - value
                                    additionalProperties: false
                              required:
                                - placeholder
                                - options
                              additionalProperties: false
                          required:
                            - id
                            - type
                            - label
                            - data
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                                - callback
                            label:
                              type: string
                            data:
                              type: object
                              properties:
                                url:
                                  type: string
                              required:
                                - url
                              additionalProperties: false
                          required:
                            - id
                            - type
                            - label
                            - data
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                                - copy
                            label:
                              type: string
                            data:
                              type: object
                              properties:
                                value:
                                  type: string
                                description:
                                  type: string
                                language:
                                  type: string
                                  enum:
                                    - text
                                    - json
                                    - bash
                              required:
                                - value
                              additionalProperties: false
                          required:
                            - id
                            - type
                            - label
                            - data
                          additionalProperties: false
                  next:
                    type: object
                    properties:
                      text:
                        type: string
                      step:
                        type: string
                      url:
                        type: string
                    additionalProperties: false
                required:
                  - description
                  - fields
                  - next
                additionalProperties: false
      security:
        - apiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X GET 'http://localhost:8080/v1/sync/your_slug/flow' \
              -H 'Authorization: Bearer ek_live_xxxxx'
        - lang: javascript
          label: TypeScript
          source: >-
            const response = await
            fetch('http://localhost:8080/v1/sync/your_slug/flow', {
              method: 'GET',
              headers: {
                Authorization: 'Bearer ek_live_xxxxx',
              },
            });


            const data = await response.json();
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'http://localhost:8080/v1/sync/your_slug/flow',
                headers={
                    'Authorization': 'Bearer ek_live_xxxxx',
                },
            )

            data = response.json()
components:
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key authentication. Pass `Authorization: Bearer ek_live_xxxxx` on
        every request.

````