> For the complete documentation index, see [llms.txt](https://docs.vomevolunteer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vomevolunteer.com/resources/editor-6/the-sequence-object.md).

# The Sequence Object

```json
{
  "id": "4f3c95f8-9422-4c19-a0d2-16ce344b5b5d",
  "created_at": "2026-02-05T07:40:29.324645Z",
  "updated_at": "2026-02-07T11:10:00Z",
  "title": "Welcome Flow",
  "description": "Getting started",
  "folder": {
    "id": "4ae2f969-a6ed-4e52-b720-c5db1d85fdb2",
    "name": "Basketball"
  },
  "status": "Published",
  "display_status": "Public",
  "number_users_active": 3,
  "number_users_paused": 0,
  "number_users_inactive": 0,
  "number_users_finished": 1,
  "number_active_steps": 2,
  "step_info": [
    {
      "id": "a437d244-c22a-4be1-8a72-6dd3f0e8af32",
      "step": 1,
      "type": 1,
      "type_display": "Interview",
      "step_details": [
        {
          "id": "74ac1ec8-e26c-4984-b868-79c55e245c66",
          "title": "Interview",
          "description": "Interview step"
        }
      ]
    }
  ]
}
```

This object represents a sequence within your organization. A sequence groups onboarding or workflow steps together and tracks how many users are active, paused, inactive, or finished in that sequence.

Response Object:

* `id`: The unique UUID of the sequence.
* `created_at`: The timestamp when the sequence was created.
* `updated_at`: The timestamp when the sequence was last updated.
* `title`: The title or name of the sequence.
* `description`: A short description of the sequence.
* `folder`: The folder the sequence belongs to, if one is set.
* `folder.id`: The unique UUID of the sequence folder.
* `folder.name`: The name of the sequence folder.
* `status`: The display value of the sequence status in the response. Possible values are `Draft`, `Published`, and `Unpublished`.
* `display_status`: The display value of the sequence visibility in the response. Possible values are `Private` and `Public`.
* `number_users_active`: Count of volunteers currently active in the sequence.
* `number_users_paused`: Count of volunteers currently paused in the sequence.
* `number_users_inactive`: Count of volunteers currently inactive in the sequence.
* `number_users_finished`: Count of volunteers who have finished the sequence.
* `number_active_steps`: Count of active steps attached to the sequence.
* `step_info`: An ordered array of sequence step objects.
* `step_info.id`: The unique UUID of the step.
* `step_info.step`: The step number within the sequence.
* `step_info.type`: The numeric step type identifier.
* `step_info.type_display`: The human-readable step type.
* `step_info.step_details`: Step-specific details. The shape varies by step type.

Detailed Step Info Breakdown

Step Info Object

* `id` (string): Unique identifier of the sequence step row.
* `step` (integer): Sequential order number of the step.
* `type` (integer): Numeric type of the step.
* `type_display` (string): Human-readable name of the step type.
* `step_details` (array): Detailed metadata for the step. The structure depends on `type`.

Step Types

* `0`: Forms And Waiver
* `1`: Interview
* `2`: Training
* `3`: Orientation
* `4`: Onboarding Other
* `5`: Electronic Signature
* `6`: Form Step
* `7`: Video
* `8`: Checklist
* `9`: Sterling Background Check
* `10`: SCORM File

Step Details by Type

* For `0`, `1`, `2`, `3`, and `4`, `step_details` returns an array of basic content objects with:
  * `id` (string): Unique identifier of the underlying step content item.
  * `title` (string): Title of the step content item.
  * `description` (string): Description of the step content item.
* For `5` (Electronic Signature), `step_details` returns an array of electronic signature objects with:
  * `document_title` (string): Title of the signature document.
  * `description` (string): Description of the signature document.
  * `document_file` (string | null): File attached to the electronic signature step.
  * `is_active` (boolean): Whether the step is active.
  * `signature_areas` (array): Signature field definitions on the document.
  * `user_electronic_signatures` (array): User-specific signature records. In `/api/sequences/`, this is typically empty because the endpoint is not user-scoped.
* For `9` (Sterling Background Check), `step_details` returns an array of background check objects with:
  * `title` (string): Step title.
  * `description` (string): Step description.
  * `package_id` (string): Sterling package identifier.
  * `is_active` (boolean): Whether the step is active.
  * `user_sterling_step` (array): User-specific Sterling records. In `/api/sequences/`, this is typically empty because the endpoint is not user-scoped.
* For `10` (SCORM File), `step_details` returns an array of SCORM course objects with:
  * `title` (string): Step title.
  * `description` (string): Step description.
  * `scorm_file` (string | null): SCORM file reference.
  * `is_active` (boolean): Whether the step is active.
  * `cloud_course_id` (string | null): Cloud course identifier.
  * `user_scorm_step` (array): User-specific SCORM step records. In `/api/sequences/`, this is typically empty because the endpoint is not user-scoped.
* If a step type has no expanded serializer in this endpoint, or the related step record is missing, `step_details` is returned as an empty array.