Skip to content
KynectLocal Docs

List forms

GET
/v1/brands/{brandId}/forms
 
curl --request GET \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/forms \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
brandId
required
string format: uuid

Brand identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
forms
required
Array<object>
object
id
required

Form identifier

string format: uuid
brandId
required

Parent brand

string format: uuid
name
required

Form display name

string
slug
required

URL-safe form slug (used in public submit URL)

string
type
required

Form type

string
Allowed values: CONTACT LEAD_CAPTURE
fields
required

Form field definitions

Array<object>
object
name
required

Field identifier key

string
label
required

Field display label

string
type
required

Input type

string
Allowed values: text email phone textarea select
required
required

Whether the field is required

boolean
options

Options for select fields

Array<string>
notificationEmail
required

Notification recipient email

string | null
webhookUrl
required

Webhook URL for lead delivery

string | null
successMessage
required

Message shown after successful submission

string | null
successRedirectUrl
required

URL to redirect to after submission

string | null
isActive
required

Whether the form accepts submissions

boolean
leadCount

Number of leads collected (list view only)

integer
createdAt
required

Creation timestamp

string format: date-time
updatedAt
required

Last update timestamp

string format: date-time
Example 
{
  "data": {
    "forms": [
      {
        "type": "CONTACT",
        "fields": [
          {
            "type": "text"
          }
        ]
      }
    ]
  }
}

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"
  }
}