Skip to content
KynectLocal Docs

Get public form definition

GET
/public/forms/{formSlug}
 
curl --request GET \
  --url https://kynectlocal-production.up.railway.app/v1/public/forms/example

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
formSlug
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
id
required

Form identifier

string format: uuid
slug
required

Form slug

string
title
required

Form title

string
fields
required

Form fields

Array<object>
object
key
required

Field key

string
label
required

Display label

string
type
required

Field type

string
required
required

Whether required

boolean
placeholder

Placeholder text

string
options

Select options

Array<string>
successMessage
required

Success message shown after submission

string | null
redirectUrl
required

Redirect URL after successful submission

string | null
Example generated
{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "slug": "example",
    "title": "example",
    "fields": [
      {
        "key": "example",
        "label": "example",
        "type": "example",
        "required": true,
        "placeholder": "example",
        "options": [
          "example"
        ]
      }
    ],
    "successMessage": "example",
    "redirectUrl": "example"
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}