Get a form

GET

/api/v1/forms/{id}

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/forms/example \
  --header 'Authorization: <Authorization>'

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Form ID

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

allowed_origins

Array<string>

created_at

string

deleted_at

string

enabled

boolean

endpoint_url

string

honeypot_field

string

id

string

name

Name is the dashboard identity, unique per project among live rows only — a soft-deleted form releases its name (uq_forms_project_name_active).

string

notify_emails

Array<string>

project_id

ProjectID is immutable after creation. This is enforced structurally rather than by a check: UpdateFormInput has no project_id field, so no code path can reassign it.

string

public_id

PublicID is immutable after creation: it is baked into the customer’s deployed HTML, so regenerating it would silently break every live form pointing at it.

string

redirect_url

string

retention_days

integer

source

string

Allowed values: manual build_detected

store_ip

string

Allowed values: none truncated

team_id

string

updated_at

string

Example

{
  "data": {
    "source": "manual",
    "store_ip": "none"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}