ListForms

POST /core.v1.WorkflowService/ListForms

cURL

cURL

curl -X POST "https://api.joinformal.com/core.v1.WorkflowService/ListForms" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'

200

{
  "forms": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "fields": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "config": {
            "options": [
              {
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "optionsSource": {
              "app": "<string>",
              "command": {
                "name": "<string>"
              },
              "machineUserId": "<string>",
              "input": {},
              "transform": "<string>"
            }
          }
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "listMetadata": {
    "after": "<string>",
    "before": "<string>",
    "count": 123,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-KEY · string · header · required

API key authentication. Get your API key from the Formal console.

Body

application/json

limit · integer<int32>

Required range: x <= 500

cursor · string

order · string

search · string

searchFields · enum<string>[]

Available options: name, description

Response

200

application/json

Success

forms · Form · object[]

Show child attributes

listMetadata · list_metadata · object

Show child attributes