Rapid Logging for Productivity and Journaling via Laravel Framework with an Instrument-Agnostic Approach
This documentation aims to provide all the information you need to work with the JotSauce API.
To authenticate requests, include an Authorization
header with the value "Bearer {YOUR_AUTH_KEY}"
.
All authenticated endpoints are marked with a requires authentication
badge in the documentation below.
You can retrieve your token by using the Login endpoint.
Check if an email has already been used to register.
curl --request POST \
"https://jotsauce.com/api/auth/email-availability" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"example@jotsauce.com\"
}"
{
"available": true
}
Check if a username has already been used to register.
curl --request POST \
"https://jotsauce.com/api/auth/username-availability" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"username\": \"baeutldntxyibwzapkxx\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 60
x-ratelimit-remaining
: 56
vary
: Origin
{
"available": true
}
Before submitting a Register request, you may use the Email Availability and Username Availability endpoints to determine if they are already in use.
curl --request POST \
"https://jotsauce.com/api/auth/register" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"username\": \"n\",
\"email\": \"fcorkery@example.com\",
\"password\": \";0A|gXl2\",
\"token\": \"b7692ddf-4969-357a-ad74-44e85086d5bc\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 60
x-ratelimit-remaining
: 57
vary
: Origin
{
"message": "The username field must be at least 3 characters. (and 2 more errors)",
"errors": {
"username": [
"The username field must be at least 3 characters."
],
"password": [
"The password field confirmation does not match."
],
"token": [
"The selected token is invalid."
]
}
}
curl --request POST \
"https://jotsauce.com/api/auth/login" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email_or_username\": \"example@jotsauce.com\",
\"password\": \"Password123!\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 60
x-ratelimit-remaining
: 58
vary
: Origin
{
"message": "The email or username must be a valid email or username.",
"errors": {
"credentials": [
"The email or username must be a valid email or username."
]
}
}
curl --request GET \
--get "https://jotsauce.com/api/auth/logout" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return General Settings For The API
curl --request GET \
--get "https://jotsauce.com/api/settings" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 60
x-ratelimit-remaining
: 54
vary
: Origin
{
"invitations": {
"invite_only": true,
"default_invitations_remaining": 3
}
}
Create a new Invitation Request
curl --request POST \
"https://jotsauce.com/api/invitationRequests" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"example@jotsauce.com\",
\"message\": \"Please let me join!\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 60
x-ratelimit-remaining
: 55
vary
: Origin
{
"email": "example@jotsauce.com",
"message": "Please let me join!",
"created_at": "2023-11-08T23:19:22.000000Z"
}
Check To See If Invitation Token Is Valid
curl --request POST \
"https://jotsauce.com/api/auth/invitation-token-verification" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"4178aa4d-96c4-3c52-9b43-d4e94c27169c\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 60
x-ratelimit-remaining
: 59
vary
: Origin
{
"message": "The selected token is invalid.",
"errors": {
"token": [
"The selected token is invalid."
]
}
}
List Of Invitations
curl --request GET \
--get "https://jotsauce.com/api/invitations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Create A New Invitation
curl --request POST \
"https://jotsauce.com/api/invitations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"example@jotsauce.com\"
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return The Specified Invitation
The ID of the invitation.
curl --request GET \
--get "https://jotsauce.com/api/invitations/magni" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Delete The Specified Invitation
The ID of the invitation.
curl --request DELETE \
"https://jotsauce.com/api/invitations/qui" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Restore The Specified Trashed (Soft-Deleted) Invitation
The ID of the invitation.
curl --request PUT \
"https://jotsauce.com/api/invitations/sint/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
List Of Trashed (Soft-Deleted) Invitations
curl --request GET \
--get "https://jotsauce.com/api/invitations/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return The Specified Trashed (Soft-Deleted) Invitation
The ID of the invitation.
curl --request GET \
--get "https://jotsauce.com/api/invitations/tempora/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Permanently Remove The Invitation From The Server
The ID of the invitation.
curl --request DELETE \
"https://jotsauce.com/api/invitations/facere/annihilate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/jots/archived" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/jots/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Permanently remove Jot from the server
The ID of the jot.
curl --request DELETE \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/annihilate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request PUT \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/archive" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request GET \
--get "https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/archived" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request PUT \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request GET \
--get "https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request PUT \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/unarchive" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return a list of jots created by the user.
curl --request GET \
--get "https://jotsauce.com/api/jots" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request POST \
"https://jotsauce.com/api/jots" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Weight Tracker\",
\"description\": \"A Daily Weight Tracker\",
\"slug\": \"research-paper\",
\"order\": 3,
\"is_public\": false
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request GET \
--get "https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request PUT \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Weight Tracker\",
\"description\": \"A Daily Weight Tracker\",
\"slug\": \"research-paper\",
\"order\": 3,
\"is_public\": false
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request DELETE \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/compositions/archived" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/compositions/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Permanently remove Jot from the server
The ID of the composition.
curl --request DELETE \
"https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/annihilate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request PUT \
"https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/archive" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request GET \
--get "https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/archived" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request PUT \
"https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request GET \
--get "https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request PUT \
"https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/unarchive" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/compositions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request POST \
"https://jotsauce.com/api/compositions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Research Paper\",
\"description\": \"All of my notes and references for the research paper\",
\"slug\": \"research-paper\",
\"order\": 3,
\"is_public\": false
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request GET \
--get "https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request PUT \
"https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Research Paper\",
\"description\": \"All of my notes and references for the research paper\",
\"slug\": \"research-paper\",
\"order\": 3,
\"is_public\": false
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request DELETE \
"https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request GET \
--get "https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/jottings/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Permanently remove Jotting from the server
The ID of the jotting.
curl --request DELETE \
"https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284/annihilate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotting.
curl --request PUT \
"https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotting.
curl --request GET \
--get "https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return a list of jottings for the specified jot
The ID of the jot.
curl --request GET \
--get "https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/jottings" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request POST \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/jottings" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"is_public\": false
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotting.
curl --request GET \
--get "https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotting.
curl --request PUT \
"https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"is_public\": false
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotting.
curl --request DELETE \
"https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request GET \
--get "https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/jotElements/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Permanently remove Jot Element from the server
The ID of the jotElement.
curl --request DELETE \
"https://jotsauce.com/api/jotElements/3a1fe0b4-7274-418d-8c53-c65a29ca30e8/annihilate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotElement.
curl --request PUT \
"https://jotsauce.com/api/jotElements/3a1fe0b4-7274-418d-8c53-c65a29ca30e8/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotElement.
curl --request GET \
--get "https://jotsauce.com/api/jotElements/3a1fe0b4-7274-418d-8c53-c65a29ca30e8/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return a list of jot elements for the specified jot
The ID of the jot.
curl --request GET \
--get "https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/jotElements" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jot.
curl --request POST \
"https://jotsauce.com/api/jots/11903b26-8e9d-440e-869b-aab0a2bc97b9/jotElements" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"jottingable_type\": \"jottingable_number\",
\"title\": \"Weight\",
\"description\": \"Weight (in lbs.)\",
\"order\": 3
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotElement.
curl --request GET \
--get "https://jotsauce.com/api/jotElements/3a1fe0b4-7274-418d-8c53-c65a29ca30e8" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotElement.
curl --request PUT \
"https://jotsauce.com/api/jotElements/3a1fe0b4-7274-418d-8c53-c65a29ca30e8" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Weight\",
\"description\": \"Weight (in lbs.)\",
\"order\": 3
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotElement.
curl --request DELETE \
"https://jotsauce.com/api/jotElements/3a1fe0b4-7274-418d-8c53-c65a29ca30e8" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/users/current" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/instruments/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Permanently remove Instrument from the server Only the user who created the Instrument can annihilate it
The ID of the instrument.
curl --request DELETE \
"https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000/annihilate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the instrument.
curl --request PUT \
"https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the instrument.
curl --request GET \
--get "https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
This will only return instruments created by the user. Users do not need a list of all instruments not created by them.
curl --request GET \
--get "https://jotsauce.com/api/instruments" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request POST \
"https://jotsauce.com/api/instruments" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Vue Frontend\",
\"description\": \"A frontend web app built with Vue\"
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Any user can view any instrument given the ID
The ID of the instrument.
curl --request GET \
--get "https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Only the user who created the Instrument can update it
The ID of the instrument.
curl --request PUT \
"https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Vue Frontend\",
\"description\": \"A frontend web app built with Vue\"
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Only the use user who created the Instrument can delete it
The ID of the instrument.
curl --request DELETE \
"https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Permanently remove Jottingable from the server
The ID of the jottingable.
curl --request DELETE \
"https://jotsauce.com/api/jottingables/006bbcdc-b5ef-46a7-856a-225b5ecf84e9/annihilate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jottingable.
curl --request PUT \
"https://jotsauce.com/api/jottingables/006bbcdc-b5ef-46a7-856a-225b5ecf84e9/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jottingable.
curl --request GET \
--get "https://jotsauce.com/api/jottingables/006bbcdc-b5ef-46a7-856a-225b5ecf84e9/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotting.
The ID of the jotElement.
curl --request POST \
"https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284/jotElements/3a1fe0b4-7274-418d-8c53-c65a29ca30e8/jottingables" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": 160.3
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jottingable.
curl --request GET \
--get "https://jotsauce.com/api/jottingables/006bbcdc-b5ef-46a7-856a-225b5ecf84e9" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jottingable.
curl --request PUT \
"https://jotsauce.com/api/jottingables/006bbcdc-b5ef-46a7-856a-225b5ecf84e9" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": 160.3
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jottingable.
curl --request DELETE \
"https://jotsauce.com/api/jottingables/006bbcdc-b5ef-46a7-856a-225b5ecf84e9" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return a list of jottingables for the specified jotting
The ID of the jotting.
curl --request GET \
--get "https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284/jottingables" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the jotting.
curl --request GET \
--get "https://jotsauce.com/api/jottings/0057517b-2218-4904-b45a-661213391284/jottingables/trashed" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/jottingableTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/taggableTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/tags/sit/facilis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
curl --request POST \
"https://jotsauce.com/api/tags/magni/occaecati" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"tags\": [
\"id\"
]
}"
curl --request GET \
--get "https://jotsauce.com/api/instrumentMetacontextableTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the instrumentMetacontext.
curl --request GET \
--get "https://jotsauce.com/api/instrumentMetacontexts/43b62211-f5a8-4876-988f-d806b167d8d5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the instrumentMetacontext.
curl --request PUT \
"https://jotsauce.com/api/instrumentMetacontexts/43b62211-f5a8-4876-988f-d806b167d8d5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"meta\": \"[\\\"recusandae\\\",\\\"repellat\\\"]\"
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the instrumentMetacontext.
curl --request DELETE \
"https://jotsauce.com/api/instrumentMetacontexts/43b62211-f5a8-4876-988f-d806b167d8d5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the instrument.
curl --request GET \
--get "https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000/instrumentMetacontexts/43b62211-f5a8-4876-988f-d806b167d8d5/omnis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the instrument.
curl --request POST \
"https://jotsauce.com/api/instruments/00000000-0000-0000-0000-000000000000/instrumentMetacontexts/43b62211-f5a8-4876-988f-d806b167d8d5/iste" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"meta\": \"[\\\"sed\\\",\\\"voluptatum\\\"]\"
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
curl --request GET \
--get "https://jotsauce.com/api/compositionableTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the composition.
curl --request POST \
"https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/compositionables" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"compositionable_type\": \"jot\",
\"compositionable_id\": \"fbc0ac70-c79f-34b0-a7e2-3fd6fbd2fc86\",
\"order\": 3
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the compositionable.
curl --request GET \
--get "https://jotsauce.com/api/compositionables/510a78c5-38a2-41b4-99f6-2f84f6ad5c33" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the compositionable.
curl --request PUT \
"https://jotsauce.com/api/compositionables/510a78c5-38a2-41b4-99f6-2f84f6ad5c33" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"order\": 3
}"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
The ID of the compositionable.
curl --request DELETE \
"https://jotsauce.com/api/compositionables/510a78c5-38a2-41b4-99f6-2f84f6ad5c33" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}
Return a list of compositionables for the specified composition
The ID of the composition.
curl --request GET \
--get "https://jotsauce.com/api/compositions/0cfd5dad-5497-4695-82aa-283e67b0838e/compositionables" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
vary
: Origin
{
"success": false,
"message": "Unauthenticated.",
"data": []
}