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."
}

Last updated