Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Form Fields

List all form fields in a workflow

Gets a page of form fields for a workflow. Form fields are paged, meaning the links section in the response must be used to get the next/previous batch of form fields.

get/workflows/{workflowId}/form-fields

Path parameters

workflowIdstring required

The ID of the Workflow

Query parameters

_string

Opaque pagination cursor. Take this value from the previous response's links[] entry whose name is "next" (typically just follow that link's href instead of reading this value). Omit on the first page. If the previous response had no next link, there are no more pages.

Response

Example response

{
  "fields": [
    {
      "audit": {
        "createdBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        },
        "updatedBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      }
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}