List Forms | Moveworks

curl -G http://localhost:5000/myinstance1/forms \
     -H "Authorization: Bearer <token>" \
     -d offset=1 \
     -d limit=1

{
  "results": [
    {
      "id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
      "domain": "IT",
      "title": "Local Admin Access",
      "url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
      "last_updated_at": "2022-10-20T07:00:00Z",
      "image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
      "description": "Lorem Ipsum",
      "short_description": "Lorem Ipsum",
      "fields": [
        {
          "name": "permissions",
          "label": "Which permissions do you need?",
          "type": "LABEL",
          "placeholder": "Enter text here.",
          "help": "If you need help figuring out which access you need, ask your bot.",
          "default_to_current_user": false,
          "options": [
            {
              "label": "System Administrator",
              "value": "system_administrator"
            }
          ],
          "required": false,
          "visible": true
        }
      ],
      "dynamic_field_rules": [
        {
          "name": "Hide 2FA if write access not needed",
          "conditions": [
            {
              "field_name": "2fa_device",
              "operator": "EQUALS",
              "value": true
            }
          ],
          "actions": [
            {
              "field_name": "read_or_write",
              "visible": false,
              "required": true
            }
          ],
          "logical": "AND"
        }
      ]
    }
  ]
}

Forms should be returned from this API in a deterministic order. Deterministic order is desired if we decide to use pagination. Anticipated load – Moveworks will call this endpoint to iterate over all forms provided by this endpoint once every 24 hours. This API is primarily used for ingestion.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KEYstring

API Key authentication via header

Query parameters

offsetlongRequired

Given a deterministically ordered list of articles, skips this many forms before returning form records

limitlongRequired

Number of forms to return in a single query. Recommended max: 100 records / request.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests you're permitted to make per minute.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-RateLimit-Resetstring or null

The remaining window before the rate limit FULLY resets in UTC epoch seconds.

Response

List of forms

resultslist of objects or null