> 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/search-sequences.md). # Search Sequences This endpoint allows for the efficient searching and filtering of sequence records based on specified query parameters such as title, description, status, visibility, and created date. It is designed to support operations that require accessing detailed sequence information quickly and effectively. Endpoint and Usage: Endpoint: `GET /api/sequences/search/` Base URL: `https://api.vomevolunteer.com` Query Parameters: Core Filters * `id` (uuid): Filters sequences by ID. * `title` (string): Filters sequences by title. * `description` (string): Filters sequences by description. * `status` (string): Filters sequences by status (`0` = Draft, `1` = Published, `2` = Unpublished). * `display_status` (string): Filters sequences by visibility (`0` = Private, `1` = Public). * `created_at` (string, ISO-8601): Filters sequences by exact `created_at`. * `created_at.gt` (string, ISO-8601): Filters by `created_at > value`. * `created_at.gte` (string, ISO-8601): Filters by `created_at >= value`. * `created_at.lte` (string, ISO-8601): Filters by `created_at <= value`. * `created_at.lt` (string, ISO-8601): Filters by `created_at < value`. * `ordering` (string): Sorts results by `created_at` or `-created_at`. Sequence Statuses * `0`: Draft * `1`: Published * `2`: Unpublished Display Statuses * `0`: Private * `1`: Public Sample Requests ```http # id GET /api/sequences/search/?id=4f3c95f8-9422-4c19-a0d2-16ce344b5b5d # title GET /api/sequences/search/?title=welcome # description GET /api/sequences/search/?description=onboarding # status GET /api/sequences/search/?status=1 # display_status GET /api/sequences/search/?display_status=1 # created_at GET /api/sequences/search/?created_at=2026-02-05T07:40:29.324645Z # created_at.gt GET /api/sequences/search/?created_at.gt=2026-02-05T07:40:29.324645Z # created_at.gte GET /api/sequences/search/?created_at.gte=2026-02-05T07:40:29.324645Z # created_at.lt GET /api/sequences/search/?created_at.lt=2026-02-05T07:40:29.324645Z # created_at.lte GET /api/sequences/search/?created_at.lte=2026-02-05T07:40:29.324645Z # ordering ascending GET /api/sequences/search/?ordering=created_at # ordering descending GET /api/sequences/search/?ordering=-created_at ``` Authorization: Requests to this endpoint require an `API-KEY` in the header for authentication. ```python headers = { "API-KEY": "your_unique_api_key_here" } response = requests.get( "https://api.vomevolunteer.com/api/sequences/search/?title=welcome&status=1", headers=headers ) ``` Response Structure: The response from this endpoint returns a paginated list of sequences that match the query parameters, including folder metadata, counts, and step information for each sequence. Example Response Object: ```json { "count": 1, "next": null, "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": [] } ] } ``` Example Response Structure Summary Information * `count`: Total number of matching sequences. * `next`: URL for the next page of results, or `null`. * `previous`: URL for the previous page of results, or `null`. Sequence Object * `id`: Unique ID of the sequence. * `created_at`: Created timestamp of the sequence. * `updated_at`: Last updated timestamp of the sequence. * `title`: Sequence title. * `description`: Sequence description. * `folder`: Related folder object, or `null`. * `status`: Human-readable sequence status in the response. * `display_status`: Human-readable visibility status in the response. * `number_users_active`: Count of active users. * `number_users_paused`: Count of paused users. * `number_users_inactive`: Count of inactive users. * `number_users_finished`: Count of finished users. * `number_active_steps`: Count of active steps. * `step_info`: Ordered step metadata array. Validation Rules * Invalid timestamps return `400 Bad Request`. * `ordering` only accepts `created_at` or `-created_at`. * If no `ordering` is supplied, results default to `-created_at`. Example validation error: ```json { "detail": "Invalid date format for created_at." } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.vomevolunteer.com/resources/editor-6/search-sequences.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.