List all sequences

Endpoint and Request Method:

GET /api/sequences/

This endpoint retrieves a paginated list of all sequences for the authenticated institution.

Example Request:

GET https://api.vomevolunteer.com/api/sequences/

Authorization:

Requests to this endpoint require an API-KEY in the header for authentication.

headers = {
    "API-KEY": "your_unique_api_key_here"
}

response = requests.get(
    "https://api.vomevolunteer.com/api/sequences/",
    headers=headers
)

Supported query parameters:

• page: Page number.

• page_size: Number of results per page, up to 100.

• status: Filters by sequence status (0 = Draft, 1 = Published, 2 = Unpublished).

• display_status: Filters by sequence visibility (0 = Private, 1 = Public).

Response Structure:

The response is a paginated object containing sequence records. Each record represents a single sequence along with folder details, volunteer counts, and step metadata.

Response Object:

{
  "count": 2,
  "next": "https://api.vomevolunteer.com/api/sequences/?page=2",
  "previous": null,
  "results": [
    {
      "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": "e3ef4ae1-1ba9-4df8-b5c9-8588ee53b272",
      "created_at": "2026-02-03T09:12:00Z",
      "updated_at": "2026-02-06T12:20:00Z",
      "title": "Safety Training Flow",
      "description": "Compliance onboarding",
      "folder": null,
      "status": "Draft",
      "display_status": "Private",
      "number_users_active": 0,
      "number_users_paused": 0,
      "number_users_inactive": 0,
      "number_users_finished": 0,
      "number_active_steps": 2,
     "step_info": [
        {
          "id": "cb776f05-6404-44c6-8ed4-0aafdaca9a87",
          "step": 1,
          "type": 1,
          "type_display": "Interview",
          "step_details": [
            {
              "id": "104faf42-9dca-450e-9b3b-7a4cd38af999",
              "title": "In-person",
              "description": "<p>In person</p>"
            }
          ]
        },
        {
          "id": "b8d50e3f-2db1-4f69-af5d-8edec959cd1b",
          "step": 2,
          "type": 3,
          "type_display": "Orientation",
          "step_details": [
            {
              "id": "540ad4f0-ed49-47bf-9ee8-07a69dc2af68",
              "title": "Orientation Session",
              "description": "<p>Orientation Session</p>"
            }
          ]
        }
      ]
    }
    }
  ]
}