SCscrive
Instances

Get a Flow instance

Gets all details about an instance.

get/experimental/flow/instances/{instance_id}

Request

Path parameters

instance_idstring uuid required

Unique identifier of the requested instance.

Response

idstring uuid required

Unique identifier of the instance.

titlestring
access_linksobject required
status'in_progress' | 'finalising' | 'canceled' | 'rejected' | 'completed' | 'failed' | 'timed_out' required

The execution status of the Flow instance.

startedstring yyyy-mm-ddThh:MM:ssZ required
finishedstring yyyy-mm-ddThh:MM:ssZ
last_eventstring yyyy-mm-ddThh:MM:ssZ required
trashedstring yyyy-mm-ddThh:MM:ssZ
author_idstring required

Unique Scrive User ID.

folder_idstring required

Unique Scrive Folder ID.

timeoutstring yyyy-mm-ddThh:MM:ssZ

The date when the instance times out.

documentsDocumentID[] required
initiator'flow_api' | 'id_check' | 'journey_service' required

Who initiated the Flow instance.

Note: This value is for internal use only and subject to change without prior notice.

latest_reminderstring yyyy-mm-ddThh:MM:ssZ

Timestamp of the most recent reminder sent in this instance, across all participants and covering both manual, bulk and automatic reminders.

Example response

{
  "access_links": {
    "user1": "https://some-env.scrive.com/experimental/flow/overview/eb4af357-28c9-410f-b432-66860955bc13/user1/ba5d504d14618def"
  },
  "admin_actions": [
    {
      "action": "notify_participant",
      "participant_id": "78b4265b-e96e-4172-97b8-1144f6e71729"
    }
  ],
  "author_id": "123",
  "callback": {
    "auth_type": "none",
    "url": "https://www.example.com/",
    "version": 1
  },
  "documents": [
    "123"
  ],
  "finished": null,
  "folder_id": "456",
  "id": "30602e94-4205-4fa0-86b7-49205503c22b",
  "initiator": "flow_api",
  "last_event": "2021-05-04T00:00:00Z",
  "latest_reminder": "2026-01-15T09:30:00Z",
  "participants": [
    {
      "authentications": [
        {
          "label": "authId",
          "max_attempts_reached": false,
          "parameters": {
            "attempts_per_sms": 5,
            "mobile_number": null,
            "provider": "sms_otp"
          },
          "type": "standard"
        }
      ],
      "automatic_reminder": {
        "date": "2026-01-15T09:30:00Z",
        "settings": {
          "date": {
            "days_delay": 7,
            "repeat": null,
            "time": null,
            "type": "relative"
          },
          "method": "email"
        }
      },
      "dsl_name": "user1",
      "latest_reminder": "2021-05-04T00:00:00Z",
      "participant_id": "78b4265b-e96e-4172-97b8-1144f6e71729",
      "tags": [
        {
          "category": "full_name",
          "value": "John Doe"
        },
        {
          "category": "email",
          "value": "private.user@example.com"
        },
        {
          "category": "email",
          "value": "corporate.user@example.com"
        }
      ]
    }
  ],
  "process": {
    "allow-rejections": true,
    "automatic-reminders": [],
    "dsl-version": "0.2.0",
    "stages": [
      {
        "initial-stage": {
          "actions": [
            {
              "notify": {
                "kind": "standard",
                "methods": {
                  "email": "msg1",
                  "email-link-only": null,
                  "sms": "msg2"
                },
                "users": [
                  "user1"
                ]
              }
            }
          ],
          "expect": {
            "signed-by": {
              "documents": [
                "doc1",
                "doc2"
              ],
              "users": [
                "user1"
              ]
            }
          }
        }
      }
    ]
  },
  "process_parameters": {
    "documents": {
      "doc1": "123"
    },
    "messages": {
      "msg1": "foobar"
    },
    "users": {
      "user1": {
        "auth_to_view": {
          "attempts_per_sms": 1,
          "max_failures": 3,
          "provider": "sms_otp"
        },
        "auth_to_view_archived": null,
        "id": "foo@example.com",
        "id_type": "email"
      }
    }
  },
  "started": "2021-01-27T00:00:00Z",
  "state": {
    "available_actions": [
      {
        "document": "123",
        "type": "sign",
        "user": {
          "id": "foo@example.com",
          "id_type": "email"
        }
      }
    ]
  },
  "status": "in_progress",
  "timeout": null,
  "title": null,
  "trashed": null
}

Changes

No recorded changes to this operation across all 1 revision of this API.