Retrieve a Workflow Schema

get

https://na1.ironcladapp.com/public/api/v1/workflow-schemas/{id}

Returns the fields used in the workflow's launch form.

OAuth Scope required: public.workflows.readSchemas

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier of a schema (see explanation of Template ID). A list of identifiers can be retrieved using the GET /workflow-schemas endpoint. Only published workflows will have an identifier.

Query Params

form

string

Defaults to launch

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400