Process and workflow management
      Back to home
      1. Knowledge base
      2. Gamfi API Docs
      3. Process and workflow management

      Downloading the list of processes

      In this article, you will discover how to retrieve a list of processes in the Gamfi application using the API.

      To download the list of processes from the Gamfi application use the method and endpoint:

      GET + /api/app_api_admin.php/v2/workflows/process?limit=10

      Example cURL:

      curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v2/workflows/process?limit=10' \
      --header 'X-Samus-Authorization-Api-Key: {apiKey}' \
      --header 'X-Samus-Authorization-Api-Secret: {apiSecret}' \
      --header 'Content-Type: application/json'

      In place:

      • {app_name} - insert the name of your application
      • {apiKey} - insert API key
      • {apiSecret} - insert API secret

      If the response is correct (200), you will receive a confirmation:

      {
          "items": [
              {
                  "id": "a69c29e4-8ada-4802-bfb2-25c96d209b54",
                  "user_id": "3",
                  "user_forename": "John",
                  "user_surname": "Doe",
                  "user_email": "john.doe@gamfi.com",
                  "user_phone": null,
                  "user_avatar": "/image/j/Q/MnYBZTzL3J.jpg",
                  "user_allows_batch_messaging": 1,
                  "workflow_id": "3f9a81c3-132c-4660-b459-2226805b1d80",
                  "workflow_name": "Employee induction",
                  "workflow_category": "talent-and-onboarding",
                  "manager_id": "25",
                  "manager_forename": "Jane",
                  "manager_surname": "Doe",
                  "manager_email": "jane.doe@gamfi.com",
                  "manager_phone": "0048123456789",
                  "manager_avatar": null,
                  "manager_allows_batch_messaging": 1,
                  "first_day": "2024-01-01 00:00:00",
                  "created_at": "2024-02-23 08:54:10.560703",
                  "status": "ongoing",
                  "progress": 0,
                  "actions_count": 2,
                  "actions_done": 0,
                  "actions_delayed": 1,
                  "has_delayed_action": true,
                  "warnings": [
                      "process_role_user_not_assigned"
                  ]
              }
          ],
          "count": 1
      }