How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FusionAuth Form API

The Form API from FusionAuth — 4 operation(s) for form.

FusionAuth Form API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Form. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.66.0.

Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.

12 operations 4 paths 15 schemas 2 DELETE2 GET2 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1

Authentication & Security 2

FusionAuth Form API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 12

Across 4 paths, the API surfaces 12 operations — 2 DELETE, 2 GET, 2 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Form 12
POST
/api/form
Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
createForm body → 200default
POST
/api/form/field
Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
createFormField body → 200default
POST
/api/form/field/{fieldId}
Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
createFormFieldWithId 1 param body → 200default
DELETE
/api/form/field/{fieldId}
Deletes the form field for the given Id.
deleteFormFieldWithId 1 param → 200default
PATCH
/api/form/field/{fieldId}
Patches the form field with the given Id.
patchFormFieldWithId 1 param body → 200default
GET
/api/form/field/{fieldId}
Retrieves the form field with the given Id.
retrieveFormFieldWithId 1 param → 200default
PUT
/api/form/field/{fieldId}
Updates the form field with the given Id.
updateFormFieldWithId 1 param body → 200default
POST
/api/form/{formId}
Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
createFormWithId 1 param body → 200default
DELETE
/api/form/{formId}
Deletes the form for the given Id.
deleteFormWithId 1 param → 200default
PATCH
/api/form/{formId}
Patches the form with the given Id.
patchFormWithId 1 param body → 200default
GET
/api/form/{formId}
Retrieves the form with the given Id.
retrieveFormWithId 1 param → 200default
PUT
/api/form/{formId}
Updates the form with the given Id.
updateFormWithId 1 param body → 200default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are FormField (14 properties), Form (7 properties), Error (3 properties), FormFieldValidator (2 properties). Each schema is shown below with its type and property counts.

FormFieldValidator
object
2 properties
FormControl
string
FormStep
object
2 properties
FormFieldRequest
object
The FormField API request object.
2 properties
FormStepType
string
Denotes the type of form step. This is used to configure different behavior on form steps in the registration flow.
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
FormRequest
object
Form response.
1 property
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
FormType
string
FormResponse
object
Form response.
2 properties
FormField
object
14 properties
Form
object
7 properties
FormDataType
string
Error
object
Defines an error.
3 properties
FormFieldResponse
object
Form field response.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-form-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
FusionAuth Application API
FusionAuth Connector API
FusionAuth Consent API
FusionAuth Email API
FusionAuth Entity API
FusionAuth Group API
FusionAuth Health API
FusionAuth Identity API
FusionAuth Identity Provider API
FusionAuth Integration API
FusionAuth Ip Acl API
Where this information came from

This is an independent, third-party profile of FusionAuth Form API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.