Search user sequences

This endpoint allows you to search through user sequences by specific criteria.

Endpoint Description:

• Endpoint: GET /api/user-sequences/search/

• Base URL: https://api.vomevolunteer.com

Query Parameters:

Core Filters

• id (uuid): Filters user sequences by the ID.

• created_at (string): Filters user sequences by the created_at.

Sample Request:

# id
GET /api/user-sequences/search/?id==6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7

# created_at
GET /api/user-sequences/search/?created_at=2024-09-06T02:57:15.008656Z

User Filters

• user.id (uuid): Filters user sequences by the ID.

• user.first_name (string): Filters user sequences by the user's first name.

• user.last_name (string): Filters user sequences by the user's last name.

• user.email (string): Filters user sequences by the user's email .

Sample Request:

# id
GET /api/user-sequences/search/?user.id=6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7

# first_name
GET /api/user-sequences/search/?user.first_name=Aaron

# last_name
GET /api/user-sequences/search/?user.last_name=James

# email
GET //api/user-sequences/search/[email protected]

Response Structure:

The response includes a paginated list of user sequences matching the search criteria, providing comprehensive details about each sequence and associated user.

Example Response Object:

headers = {
    "API-KEY": "your_unique_api_key_here"
}
response = requests.get("https://api.vomevolunteer.com/api/form-submissions/6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7", headers=headers)

{
    "count": 49,
    "next": "http://3.96.242.26:8030/api/user-sequences/search/?first_name=Aaron&page=2",
    "previous": null,
    "results": [
        {
            "id": "4f02f472-2c15-436d-8a73-ff316cb9a78b",
            "user_info": {
                "id": "2c5f6853-7d10-427b-934b-1abc8d0ddcf1",
                "first_name": "Bill",
                "last_name": "Flood",
                "email": "[email protected]",
                "gender": null,
                "address": "",
                "phone_number": "3343455454",
                "date_of_birth": null,
                "timezone": "America/Toronto",
                "address_coordinates": null
            },
            "sequence_info": {
                "id": "071ed9bf-ccce-4a31-9ce5-96fd6a0df0d9",
                "title": "Sample Sequence Testing - 09",
                "description": "<p>Sample</p>",
                "display_status": "Public",
                "step_info": [
                    {
                        "step": 2,
                        "type": 4,
                        "custom_step_details": [
                            {
                                "title": "Custom Step (No file)",
                                "description": "<p>Sample description of a step</p>",
                                "user_sequence_info": {
                                    "id": "11254adc-444e-4b77-a51c-222c4ed7b8cf",
                                    "status": 1,
                                    "completion_date": "2024-10-10T08:04:01.798052Z",
                                    "expiration_date": null,
                                    "attachment_added": null
                                }
                            }
                        ]
                    },
                    {
                        "step": 1,
                        "type": 4,
                        "custom_step_details": [
                            {
                                "title": "Background checks 2",
                                "description": "<p>Sample</p>",
                                "user_sequence_info": {
                                    "id": "892d267e-b337-4baa-b95e-90f59a61df40",
                                    "status": 1,
                                    "completion_date": "2024-10-10T08:03:58.176127Z",
                                    "expiration_date": null,
                                    "attachment_added": null
                                }
                            }
                        ]
                    }
                ]
            },
            "status": "Active",
            "created_at": "2024-10-10T08:03:23.530521Z",
            "updated_at": "2024-10-10T08:03:58.998298Z"
        },
 
    ]
}