v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

List All Workflow Schemas

Returns a list of workflow schemas. Each schema specifies the fields used in the workflow's launch form.

OAuth Scope required: public.workflows.readSchemas

get/workflow-schemas

Query parameters

formstring required

The launch form is the only form supported at this time.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

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-idstring

Example:5f0375c4cdc1927a3c5edcd3

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.

Response

200

Example response

{
  "list": [
    {
      "id": "a1b2c3d4",
      "name": "MNDA",
      "schema": {
        "counterpartyName": {
          "type": "string",
          "displayName": "Example String Attribute",
          "required": "always",
          "options": {
            "values": [
              "Option 1",
              "Option 2",
              "Option 3"
            ],
            "freeTextAllowed": true
          },
          "default": "croissant"
        },
        "amount": {
          "type": "number",
          "displayName": "Example Number Attribute",
          "required": "always",
          "options": {
            "values": [
              "Option 1",
              "Option 2",
              "Option 3"
            ],
            "freeTextAllowed": true
          },
          "default": "croissant"
        },
        "fee": {
          "type": "monetaryAmount",
          "displayName": "Example Monetary Amount Attribute",
          "required": "always",
          "options": {
            "values": [
              "Option 1",
              "Option 2",
              "Option 3"
            ],
            "freeTextAllowed": true
          },
          "default": "croissant"
        },
        "draft": {
          "type": "array",
          "elementType": {
            "type": "document",
            "displayName": "Example Document Attribute",
            "required": "always",
            "options": {
              "values": [
                "Option 1",
                "Option 2",
                "Option 3"
              ],
              "freeTextAllowed": true
            },
            "default": "croissant"
          }
        },
        "lineItems": {
          "type": "array",
          "elementType": {
            "type": "object",
            "displayName": "Example Object Attribute",
            "required": "always",
            "options": {
              "values": [
                "Option 1",
                "Option 2",
                "Option 3"
              ],
              "freeTextAllowed": true
            },
            "default": "croissant",
            "schema": {
              "childAttribute": {
                "type": "string",
                "displayName": "Example String Attribute",
                "required": "always",
                "options": {
                  "values": [
                    "Option 1",
                    "Option 2",
                    "Option 3"
                  ],
                  "freeTextAllowed": true
                },
                "default": "croissant"
              },
              "anotherChildAttribute": {
                "type": "string",
                "displayName": "Example String Attribute",
                "required": "always",
                "options": {
                  "values": [
                    "Option 1",
                    "Option 2",
                    "Option 3"
                  ],
                  "freeTextAllowed": true
                },
                "default": "croissant"
              }
            }
          }
        },
        "exampleLinkedRecord": {
          "type": "linkedRecord",
          "displayName": "Example Linked Record",
          "required": "always",
          "schema": {
            "properties": {
              "type": "object",
              "displayName": "properties",
              "schema": {}
            }
          }
        },
        "exampleParentRecord": {
          "type": "parentRecord",
          "displayName": "Example Parent Record",
          "required": "always",
          "schema": {
            "properties": {
              "type": "object",
              "displayName": "properties",
              "schema": {}
            }
          }
        },
        "exampleChildRecord": {
          "type": "childRecord",
          "displayName": "Example Child Record",
          "required": "always",
          "schema": {
            "properties": {
              "type": "object",
              "displayName": "properties",
              "schema": {}
            }
          }
        }
      },
      "permissions": [
        "launch",
        "view"
      ]
    }
  ]
}