Retrieve a Sequence

Endpoint

GET /api/sequences/{sequence_id}/

Replace {sequence_id} with the actual ID of the sequence you wish to retrieve.

Example Request

GET /api/sequences/4f3c95f8-9422-4c19-a0d2-16ce344b5b5d/

Authorization

Requests to this endpoint must include 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/4f3c95f8-9422-4c19-a0d2-16ce344b5b5d/",
    headers=headers
)

Response Object

The response object includes details about a single sequence, including folder metadata, user counts, and step information:

{
  "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"
        }
      ]
    }
  ]
}

Common errors:

• 404 Not Found: The sequence does not exist, or it does not belong to the authenticated institution.

Example:

{
  "detail": "Not found."
}