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 Session requests that start after the specified date and time in EPOCH format (e.g., 1705732260).
end_time string optional
Filters Session requests that end before the specified date and time in EPOCH format (e.g., 1738011600).

Epoch Time

Epoch time, also known as Unix time, is a standard format used in APIs to avoid regional differences in date and time formats. Time in Epoch format represents the number of seconds (or milliseconds) since January 1, 1970, 00:00:00 UTC.

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 provide built-in functions to convert epoch time into human-readable formats and vice versa:

  • 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}}

Used to authenticate the request. Replace with your access token.

Headers

Content-Type application/json

Specifies the format of the request body.

Accept application/json

Specifies the format of the response body.

Example Request

GET https://prevail.ai/api/v1/sessions?start_time=1705732260&end_time=1738011600
        
Example Response

{
    "pagy": {
        "page": 1,
        "items": 100,
        "count": 2,
        "pages": 1
    },
    "sessions": [
        {
            "remote_session_id": "example-remote-session-id",
            "title": "Example Remote Session",
            "start_date": "2025-01-28",
            "start_time": "01:30 AM",
            "time_zone": "Pacific Time (US & Canada)",
            "state": "ready", 
            "estimated_duration": 4.0,
            "transcript_status": "in_progress",
            "invite_emails": [
                "jane@doe.com",
                "john@smith.com"
            ],
            "provider_specific_details": {
                "meeting_id": 96343137924,
                "password": "efporppd3k",
                "provider_join_url": "https://zoom.us/j/96343137924?pwd=xNwa2aDkaJgetoWF3ftAEINaRabzgF.1",
                "prevail_join_url": "https://staging.prevail.ai/sessions/example-remote-session/zoom_meeting"
            }
        },
        {
            "remote_session_id": "example-remote-session-2-id",
            "title": "Example Remote Session 2",
            "start_date": "2025-11-30",
            "start_time": "02:30 PM",
            "time_zone": "Central Time (US & Canada)",
            "state": "canceled", 
            "estimated_duration": 3.5,
            "transcript_status": "in_progress",
            "invite_emails": [
                "test1@prevail.io",
                "jane@doe.com",
                "john@smith.com",
                "addthisemail@email.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 about a specific Session, identified by its unique remote_session_id. Use this endpoint to retrieve Session metadata, participant details, and any associated data for the specified Session.

Query Parameters

remote_session_id string required
The unique identifier of the Session for which you want to retrieve data.
  • You can retrieve the remote_session_id by using the GET Sessions endpoint, which returns a list of Sessions and their IDs.
Example Request

GET https://prevail.ai/api/v1/sessions/example-remote-session-id
        
Example Response

{
    "sessions": [
        {
            "remote_session_id": "example-remote-session-id",
            "title": "Example Remote Session",
            "start_date": "2025-01-28",
            "start_time": "01:30 AM",
            "time_zone": "Pacific Time (US & Canada)",
            "state": "canceled",
            "estimated_duration": 4.0,
            "transcript_status": "in_progress",
            "invite_emails": [
                "jane@doe.com",
                "john@smith.com"
            ],
            "provider_specific_details": {
                "meeting_id": 96343137924,
                "password": "efporppd3k",
                "provider_join_url": "https://zoom.us/j/96343137924?pwd=xNwa2aDkaJgetoWF3ftAEINaRabzgF.1",
                "prevail_join_url": "https://staging.prevail.ai/sessions/example-remote-session/zoom_meeting"
            }
        }
    ]
}
        

Copyright ©2025 Prevail Legal

Last modified: January 24, 2025