LogoLogo
  • PAVE OpenAPI Overview
  • How PAVE Works
    • Capture Link
    • Guided Capture
    • Customer Disclosures
    • Identified Vehicle Information
    • Captured Photos
    • Text Notifications
    • Inspection Results
    • Condition Report (PDF)
    • Detected Damages
    • Grading
    • Languages
    • Accuracy & Limitations
  • INTEGRATIONS
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • GET Session Data
        • GET Session Photos
        • GET Session Notes
        • GET Session Results
        • PUT Update Session
        • DELETE Session
      • Webhooks
        • GET All Callbacks
        • GET View a Callback
        • POST Create New Callback
        • PUT Update a Callback
        • DELETE a Callback
      • Deep Linking
        • Deep Link with React Native App
        • Deep Link Native App
        • Deep Linking with Shareable Links
      • Pass-Through Additional User Information
      • Tracking Your Sessions
      • User Session Lifecycle
      • Developer Testing
    • Account Optional Add-ons
      • Capture Only Theme (CAPT)
        • Skip Pictures
      • Right-Hand-Drive Capture Flow
  • MANAGING YOUR ACCOUNT
    • Your Guide to PAVE's Account and Enterprise Dashboards
  • Hotspots
    • PAVE Hotspots API
    • Activating PAVE Hotspots
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • POST Upload Photos
        • GET Results
  • OTHER RESOURCES
    • PAVE Capture Troubleshooting Guide
      • iPhone (iOS) Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Get's Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
      • Android Phone Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Gets Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
    • Policies
      • Service Level Agreement and Standards
      • Service Delivery Sub-Processors & Processors
      • API Strategy and Architecture
      • Information Security Policy
        • Data Quality Guideline
        • Data Retention Policy
        • Backup and Disaster Recovery
        • Data Residency
        • Data Access Control
Powered by GitBook
On this page
  1. INTEGRATIONS
  2. Developer Docs
  3. Sessions

GET Session Notes

During a session, retrieve notes belonging to the API-Key by referencing the session_key.

https://openapi.paveapi.com/v1/sessions/:session_key/notes

Replace :session_key with the unique session_key returned from your previous request, and PAVE will return the corresponding session notes that have been inputted from the dashboard or results page (park page).

Path Parameters

session_key

string

Unique session_key generated when the new session was created

Headers

API-Key

string

The API-Key that was provided for your account

API-Token

string

The API-Token used when the session was created

API-Timestamp

string

UTC Datetime string, example: 2021-05-30T12:49:19Z

Sample Response (200:Ok)

Returns list of inputted notes: including title, description, type (for now it's only session), privacy (public, private for only logged users, only-me), user source (logged user or guest), and timestamps for when each was inputted.

[
    {
        "user": "guest",
        "title": "Here come the first note",
        "description": "Learn how to use session notes.",
        "type": "session",
        "privacy": "private",
        "timestamp": "2021-05-27T07:36:16+00:00",
    }
]

Sample Response (404: Not Found)

{
    "message": "Session :session_key cannot be found."
}
PreviousGET Session PhotosNextGET Session Results

Last updated 2 years ago