Metadata API
Programmatic access to information about flows, variants, and deployments
The API is currently in testing, and not available to all clients, hence the
/alpha prefix. At launch, the API will be prefixed with /v1 instead of /alphaWithin the Studio's API Keys tab, new API keys can be generated.
To access any of the resources, include the API key as the X-API-KEY header.
To obtain the API specification as an OpenAPI JSON, you can access:
curl https://api.formsort.com/alpha/spec --header "X-API-KEY: {{YOUR API KEY}}"
The following API paths are available at
https://api.formsort.com
GET /alpha/flows
This path returns a list of Flows.
Parameters
page(optional) - integer representing the page number.perPage(optional) - integer representing the number of results per page.
Responses
200- A list of Flows. The response schema is defined in#/definitions/FlowListing.
GET /alpha/flows/{flowLabel}/variants
This path returns a list of Variants for the specified Flow.
Parameters
flowLabel(required) - string representing the Flow label.page(optional) - integer representing the page number.perPage(optional) - integer representing the number of results per page.
Responses
200- A list of Variants. The response schema is defined in#/definitions/VariantListing.
GET /alpha/flows/{flowLabel}/variants/{variantLabel}/deployments
This path returns a list of Deployments for the specified Variant.
Parameters
flowLabel(required) - string representing the Flow label.variantLabel(required) - string representing the Variant label.page(optional) - integer representing the page number.perPage(optional) - integer representing the number of results per page.
Responses
200- A list of Deployments. The response schema is defined in#/definitions/DeploymentListing.
GET /alpha/variant-revisions/{uuid}
This path returns details of a Variant Revision.
Parameters
uuid(required) - string representing the UUID of the Variant Revision.
Responses
200- Details of a Variant Revision. The response schema is defined in#/definitions/VariantRevisionDetailed.
The following definitions are used in the API:
FlowListing: A schema representing a list of Flows.DeploymentListing: A schema representing a list of Deployments.VariantListing: A schema representing a list of Variants.VariantRevisionDetailed: A schema representing details of a Variant Revision.
The API consumes and produces JSON data (
application/json). The specific content of the JSON data is defined in the response schemas.Last modified 3mo ago