Get a sync flow step - Enkryptify Documentation

GET

sync

{slug}

flow

cURL

curl -X GET 'http://localhost:8080/v1/sync/your_slug/flow' \
  -H 'Authorization: Bearer ek_live_xxxxx'

{
  "description": "<string>",
  "fields": [
    {
      "id": "<string>",
      "type": "input",
      "label": "<string>",
      "data": {
        "placeholder": "<string>",
        "defaultValue": "<string>",
        "description": "<string>",
        "isRequired": true
      }
    }
  ],
  "next": {
    "text": "<string>",
    "step": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Pass Authorization: Bearer ek_live_xxxxx on every request.

Path Parameters

slug

string

required

Required string length: 2 - 48

Pattern: ^[a-z0-9-]+$

Query Parameters

syncConfigId

string

required

step

string

required

Response

200 - application/json

Default Response

description

string

required

fields

object[]

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

object

required

Show child attributes

Submit a sync flow stepSubmits the form for the current step of a sync setup wizard. Returns the next step's form definition or completes the configuration.

cURL

curl -X GET 'http://localhost:8080/v1/sync/your_slug/flow' \
  -H 'Authorization: Bearer ek_live_xxxxx'

{
  "description": "<string>",
  "fields": [
    {
      "id": "<string>",
      "type": "input",
      "label": "<string>",
      "data": {
        "placeholder": "<string>",
        "defaultValue": "<string>",
        "description": "<string>",
        "isRequired": true
      }
    }
  ],
  "next": {
    "text": "<string>",
    "step": "<string>",
    "url": "<string>"
  }
}