Link Search Menu Expand Document

Prevail API: View Scheduled Sessions

Retrieve Scheduled Sessions

GET https://prevail.ai/api/v1/sessions

Retrieves a list of scheduled Sessions including detailed information for each Session. Use the start_time and end_time parameters in EPOCH format to filter Sessions by time range. Results can also be filtered using pagination.

Query Parameters

start_time string optional
Filters Sessions that start after the specified time, provided in EPOCH format. For example: 1705732260.
end_time string optional
Filters Sessions that end before the specified time, provided in EPOCH format. For example: 1738011600.

Epoch Time

Epoch time, also known as Unix time, is a standard format that represents the number of seconds since January 1, 1970, 00:00:00 UTC. It avoids regional differences in date and time formatting.

For example:

  • 0 represents January 1, 1970, 00:00:00 UTC.
  • 1609459200 represents January 1, 2021, 00:00:00 UTC.

Epoch Time Conversion

Most programming languages include functions to convert between epoch time and standard date-time formats.

  • JavaScript: new Date(1609459200000) converts epoch time to a readable date.
  • Python: datetime.datetime.fromtimestamp(1609459200)
  • Online Converter: Use tools like Epoch Converter to easily convert between epoch time and standard date formats.

Authorization

Bearer Token {{jwt_signed}}

Authenticates the request. Replace with your access token.

Headers

Accept application/json

Specifies the expected format of the response body.

Example Request

cURL 
curl -X GET "https://prevail.ai/api/v1/sessions?start_time=1705732260&end_time=1738011600" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"
JavaScript 
// Get sessions using fetch API
async function listSessions() {
  const response = await fetch('https://prevail.ai/api/v1/sessions?start_time=1705732260&end_time=1738011600', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
      'Accept': 'application/json'
    }
  });

  const data = await response.json();
  console.log(data);
}

// Call the function
listSessions();
Python 
import requests

url = "https://prevail.ai/api/v1/sessions"
params = {
    "start_time": 1705732260,
    "end_time": 1738011600
}

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print(data)
HTTP 
GET https://prevail.ai/api/v1/sessions?start_time=1705732260&end_time=1738011600
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Example Response 

{
    "pagy": {
        "page": 1,
        "items": 2,
        "count": 2,
        "pages": 1
    },
    "sessions": [
        {
            "remote_session_id": "example-remote-session-id",
            "title": "Example Remote Session",    
            "start_date": "2025-01-27",
            "start_time": "11:30 AM",
            "time_zone": "Pacific Time (US & Canada)",                   
            "state": "ready",
            "estimated_duration": 4.0,
            "transcript_status": "in_progress",             
            "invites": [
                {
                    "email": "malachite@example.com"
                },
                {
                    "email": "quartz@example.com"
                },
                {
                    "email": "obsidian@example.com"
                }
            ]
        },
        {        
            "remote_session_id": "example-remote-session-2-id",
            "title": "Example Remote Session 2",    
            "start_date": "2025-01-20",
            "start_time": "03:30 PM",
            "time_zone": "Pacific Time (US & Canada)",                   
            "state": "ready",
            "estimated_duration": 4.0,
            "transcript_status": "in_progress",             
            "invites": [
                {
                    "email": "malachite@example.com"
                },
                {
                    "email": "quartz@example.com"
                },
                {
                    "email": "obsidian@example.com"
                }
            ],            
            "provider_specific_details": {
                "meeting_id": 95317175962,
                "password": "awt4zzi7jv",
                "provider_join_url": "https://zoom.us/j/95317175962?pwd=E0Vmti19iYagOKzfZH08qJNKxlb5SG.1",
                "prevail_join_url": "https://staging.prevail.ai/sessions/example-remote-session-2/zoom_meeting"            
            }    
        }
    ]
}

Retrieve Data for a Specific Session

GET https://prevail.ai/api/v1/sessions/[:remote_session_id]

Retrieves detailed information for a specific Session, identified by its unique remote_session_id. This endpoint includes metadata, participant details, and associated configuration data.

Query Parameters

remote_session_id string required
The unique identifier of the Session whose data you want to retrieve.
  • Use the GET Sessions endpoint to retrieve a list of Sessions and their remote_session_id values.

Example Request

cURL 
curl -X GET "https://prevail.ai/api/v1/sessions/example-remote-session-2-id" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"
JavaScript 
// Get session details using fetch API
async function getSessionDetails() {
  const response = await fetch('https://prevail.ai/api/v1/sessions/example-remote-session-2-id', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
      'Accept': 'application/json'
    }
  });

  const data = await response.json();
  console.log(data);
}

// Call the function
getSessionDetails();
Python 
import requests

url = "https://prevail.ai/api/v1/sessions/example-remote-session-2-id"

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)
HTTP 
GET https://prevail.ai/api/v1/sessions/example-remote-session-2-id
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Example Response 

{        
    "sessions": [
        {
            "id": 15,
            "session_state": "scheduled",
            "session_url": "https://staging.prevail.ai/sessions/example-remote-session-2-id",
            "remote_session_id": "example-remote-session-2-id",
            "session_request": {
                "session_type": "remote_deposition",
                "deponent": {
                    "name": "Malachite Yarrow",
                    "email": "malachite@example.com",
                    "role": "deponent"
                },
                "invites": [
                    {
                        "email": "quartz@example.com"
                    },
                    {
                        "email": "obsidian@example.com"
                    },
                    {
                        "email": "malachite@example.com"
                    }
                ]
            },
            "remote_session": {
                "title": "Example Remote Session 2",
                "case": "123-case-id-name",
                "start_date": "2025-01-20",
                "start_time": "03:30 PM",
                "time_zone": "Pacific Time (US & Canada)"
            },
            "session_details": {
                "language": "en-US",
                "preferred_manager": "Quartz Verbena",
                "video_provider": "zoom_meeting",
                "session_type": "remote_deposition"
            },
            "notice": null,
            "cancelation_requested": null,
            "provider_specific_details": {
                "meeting_id": 95317175962,
                "password": "awt4zzi7jv",
                "provider_join_url": "https://zoom.us/j/95317175962?pwd=E0Vmti19iYagOKzfZH08qJNKxlb5SG.1",
                "prevail_join_url": "https://staging.prevail.ai/sessions/example-remote-session-2/zoom_meeting"
            }
        }
    ]
}
Copyright ©2025 Prevail Legal

Last modified: May 08, 2025