JotSauce API

Postman collection → OpenAPI spec →

Introduction

Rapid Logging for Productivity and Journaling via Laravel Framework with an Instrument-Agnostic Approach

Base URL: https://jotsauce.com

This documentation aims to provide all the information you need to work with the JotSauce API.

Authenticating requests

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.

Authentication

Email Availability

POST

https://jotsauce.com

/api/auth/email-availability

Check if an email has already been used to register.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

An email that doesn't already exist. Must be a valid email address. Must not be greater than 255 characters.

Example:

example@jotsauce.com

Headers

Body

{ "email": "example@jotsauce.com" }

Received response

Example request:

curl --request POST \
    "https://jotsauce.com/api/auth/email-availability" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"example@jotsauce.com\"
}"

Example response:

{
    "available": true
}

Username Availability

POST

https://jotsauce.com

/api/auth/username-availability

Check if a username has already been used to register.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

username

string

required

A username that doesn't already exist. Must contain only letters, numbers, dashes and underscores. Must be at least 3 characters. Must not be greater than 255 characters.

Example:

baeutldntxyibwzapkxx

Headers

Body

{ "username": "baeutldntxyibwzapkxx" }

Received response

Example request:

curl --request POST \
    "https://jotsauce.com/api/auth/username-availability" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"baeutldntxyibwzapkxx\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 56
                                                                                                                    vary
                                                            : Origin

{
    "available": true
}

Register

POST

https://jotsauce.com

/api/auth/register

Before submitting a Register request, you may use the Email Availability and Username Availability endpoints to determine if they are already in use.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

username

string

required

A username that doesn't already exist. Must contain only letters, numbers, dashes and underscores. Must be at least 3 characters. Must not be greater than 255 characters.

Example:

string

required

An email that doesn't already exist. Must be a valid email address. Must not be greater than 255 characters.

Example:

fcorkery@example.com

password

string

required

Minimum of 8 characters. Must be at least 8 characters.

Example:

;0A|gXl2

token

string

required

Invitation token found in email. Must be a valid UUID.

Example:

b7692ddf-4969-357a-ad74-44e85086d5bc

Headers

Body

{ "username": "n", "email": "fcorkery@example.com", "password": ";0A|gXl2", "token": "b7692ddf-4969-357a-ad74-44e85086d5bc" }

Received response

Example request:

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

Example response:

Headers

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

POST

https://jotsauce.com

/api/auth/login

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

email_or_username

string

required

Example:

example@jotsauce.com

password

string

required

Password.

Example:

Password123!

Headers

Body

Received response

Example request:

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!\"
}"

Example response:

Headers

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

Logout

GET

https://jotsauce.com

/api/auth/logout

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Settings

GET

https://jotsauce.com

/api/settings

Return General Settings For The API

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

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

Invitation Requests

Store

POST

https://jotsauce.com

/api/invitationRequests

Create a new Invitation Request

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

An email that has not already been used. Must be a valid email address. Must not be greater than 255 characters.

Example:

example@jotsauce.com

message

string

(Optional) Leave a message as to why you should receive an invitation to join. Must not be greater than 1024 characters.

Example:

Please let me join!

Headers

Body

{ "email": "example@jotsauce.com", "message": "Please let me join!" }

Received response

Example 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!\"
}"

Example response:

Headers

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

Invitations

Verify Invitation Token

POST

https://jotsauce.com

/api/auth/invitation-token-verification

Check To See If Invitation Token Is Valid

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

token

string

required

Token received from email for verification of invitation. Must be a valid UUID.

Example:

4178aa4d-96c4-3c52-9b43-d4e94c27169c

Headers

Body

{ "token": "4178aa4d-96c4-3c52-9b43-d4e94c27169c" }

Received response

Example request:

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

Example response:

Headers

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

Index

GET

https://jotsauce.com

/api/invitations

requires authentication

List Of Invitations

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/invitations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Store

POST

https://jotsauce.com

/api/invitations

requires authentication

Create A New Invitation

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Email of the user you would like to invite. Must be a valid email address. Must not be greater than 255 characters.

Example:

example@jotsauce.com

Auth

Bearer

Headers

Body

{ "email": "example@jotsauce.com" }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Show

GET

https://jotsauce.com

/api/invitations/{id}

requires authentication

Return The Specified Invitation

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the invitation.

Example:

magni

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Destroy

DELETE

https://jotsauce.com

/api/invitations/{id}

requires authentication

Delete The Specified Invitation

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the invitation.

Example:

qui

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://jotsauce.com/api/invitations/qui" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Restore

PUT

PATCH

https://jotsauce.com

/api/invitations/{invitation_id}/restore

requires authentication

Restore The Specified Trashed (Soft-Deleted) Invitation

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

invitation_id

string

required

The ID of the invitation.

Example:

sint

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Trashed Index

GET

https://jotsauce.com

/api/invitations/trashed

requires authentication

List Of Trashed (Soft-Deleted) Invitations

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Trashed

GET

https://jotsauce.com

/api/invitations/{invitation_id}/trashed

requires authentication

Return The Specified Trashed (Soft-Deleted) Invitation

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

invitation_id

string

required

The ID of the invitation.

Example:

tempora

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Annihilate

DELETE

https://jotsauce.com

/api/invitations/{invitation_id}/annihilate

requires authentication

Permanently Remove The Invitation From The Server

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

invitation_id

string

required

The ID of the invitation.

Example:

facere

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jots

Handle the incoming request.

GET

https://jotsauce.com

/api/jots/archived

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Trashed (soft deleted) Jot index

GET

https://jotsauce.com

/api/jots/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Annihilate the specified Jot

DELETE

https://jotsauce.com

/api/jots/{jot_id}/annihilate

requires authentication

Permanently remove Jot from the server

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

PUT

PATCH

https://jotsauce.com

/api/jots/{jot_id}/archive

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

GET

https://jotsauce.com

/api/jots/{jot_id}/archived

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Restore the specified trashed (soft deleted) Jot

PUT

PATCH

https://jotsauce.com

/api/jots/{jot_id}/restore

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the trashed (soft deleted) Jot

GET

https://jotsauce.com

/api/jots/{jot_id}/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

PUT

PATCH

https://jotsauce.com

/api/jots/{jot_id}/unarchive

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jot index

GET

https://jotsauce.com

/api/jots

requires authentication

Return a list of jots created by the user.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/jots" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Create a new Jot

POST

https://jotsauce.com

/api/jots

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

required

A title for your jot.

Example:

Weight Tracker

description

string

(Optional) A description for your jot.

Example:

A Daily Weight Tracker

slug

string

(Optional) A URL-friendly short slug.

Example:

research-paper

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

is_public

boolean

(Optional) Should this composition appear publicly?.

Auth

Bearer

Headers

Body

{ "title": "Weight Tracker", "description": "A Daily Weight Tracker", "slug": "research-paper", "order": 3, "is_public": false }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return specified Jot

GET

https://jotsauce.com

/api/jots/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified Jot

PUT

PATCH

https://jotsauce.com

/api/jots/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Body Parameters

title

string

A title for your jot.

Example:

Weight Tracker

description

string

(Optional) A description for your jot.

Example:

A Daily Weight Tracker

slug

string

(Optional) A URL-friendly short slug.

Example:

research-paper

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

is_public

boolean

(Optional) Should this composition appear publicly?.

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Weight Tracker", "description": "A Daily Weight Tracker", "slug": "research-paper", "order": 3, "is_public": false }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Remove the specified Jot

DELETE

https://jotsauce.com

/api/jots/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Compositions

Handle the incoming request.

GET

https://jotsauce.com

/api/compositions/archived

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Trashed (soft deleted) Composition index

GET

https://jotsauce.com

/api/compositions/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Annihilate the specified Jot

DELETE

https://jotsauce.com

/api/compositions/{composition_id}/annihilate

requires authentication

Permanently remove Jot from the server

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

PUT

PATCH

https://jotsauce.com

/api/compositions/{composition_id}/archive

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

GET

https://jotsauce.com

/api/compositions/{composition_id}/archived

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Restore the specified trashed (soft deleted) Composition

PUT

PATCH

https://jotsauce.com

/api/compositions/{composition_id}/restore

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the trashed (soft deleted) Composition

GET

https://jotsauce.com

/api/compositions/{composition_id}/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

PUT

PATCH

https://jotsauce.com

/api/compositions/{composition_id}/unarchive

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Display a listing of the resource.

GET

https://jotsauce.com

/api/compositions

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/compositions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Store a newly created resource in storage.

POST

https://jotsauce.com

/api/compositions

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

required

The name of your composition.

Example:

Research Paper

description

string

(Optional) A description for your composition.

Example:

All of my notes and references for the research paper

slug

string

(Optional) A URL-friendly short slug.

Example:

research-paper

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

is_public

boolean

(Optional) Should this composition appear publicly?.

Auth

Bearer

Headers

Body

{ "title": "Research Paper", "description": "All of my notes and references for the research paper", "slug": "research-paper", "order": 3, "is_public": false }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Display the specified resource.

GET

https://jotsauce.com

/api/compositions/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified resource in storage.

PUT

PATCH

https://jotsauce.com

/api/compositions/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Body Parameters

title

string

The name of your composition.

Example:

Research Paper

description

string

(Optional) A description for your composition.

Example:

All of my notes and references for the research paper

slug

string

(Optional) A URL-friendly short slug.

Example:

research-paper

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

is_public

boolean

(Optional) Should this composition appear publicly?.

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Research Paper", "description": "All of my notes and references for the research paper", "slug": "research-paper", "order": 3, "is_public": false }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Remove the specified Composition

DELETE

https://jotsauce.com

/api/compositions/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jottings

Trashed (soft deleted) Jotting index

GET

https://jotsauce.com

/api/jots/{jot_id}/jottings/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Annihilate the specified Jotting

DELETE

https://jotsauce.com

/api/jottings/{jotting_id}/annihilate

requires authentication

Permanently remove Jotting from the server

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotting_id

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Restore the specified trashed (soft deleted) Jotting

PUT

PATCH

https://jotsauce.com

/api/jottings/{jotting_id}/restore

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotting_id

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the trashed (soft deleted) Jotting

GET

https://jotsauce.com

/api/jottings/{jotting_id}/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotting_id

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jotting index

GET

https://jotsauce.com

/api/jots/{jot_id}/jottings

requires authentication

Return a list of jottings for the specified jot

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Create a new Jotting

POST

https://jotsauce.com

/api/jots/{jot_id}/jottings

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Body Parameters

is_public

boolean

(Optional) Should this composition appear publicly?.

Auth

Bearer

Headers

URL Parameters

Body

{ "is_public": false }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the specified Jotting

GET

https://jotsauce.com

/api/jottings/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified Jotting

PUT

PATCH

https://jotsauce.com

/api/jottings/{id}

requires authentication

https://github.com/hotsaucejake/jotsauce/issues/91

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Body Parameters

is_public

boolean

(Optional) Should this composition appear publicly?.

Auth

Bearer

Headers

URL Parameters

Body

{ "is_public": false }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Remove the specified Jotting

DELETE

https://jotsauce.com

/api/jottings/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jot Elements

Trashed (soft deleted) Jot Element index

GET

https://jotsauce.com

/api/jots/{jot_id}/jotElements/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Annihilate the specified Jot Element

DELETE

https://jotsauce.com

/api/jotElements/{jotElement_id}/annihilate

requires authentication

Permanently remove Jot Element from the server

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotElement_id

string

required

The ID of the jotElement.

Example:

3a1fe0b4-7274-418d-8c53-c65a29ca30e8

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Restore the specified trashed (soft deleted) Jot Element

PUT

PATCH

https://jotsauce.com

/api/jotElements/{jotElement_id}/restore

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotElement_id

string

required

The ID of the jotElement.

Example:

3a1fe0b4-7274-418d-8c53-c65a29ca30e8

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the trashed (soft deleted) Jot Element

GET

https://jotsauce.com

/api/jotElements/{jotElement_id}/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotElement_id

string

required

The ID of the jotElement.

Example:

3a1fe0b4-7274-418d-8c53-c65a29ca30e8

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jot Element index

GET

https://jotsauce.com

/api/jots/{jot_id}/jotElements

requires authentication

Return a list of jot elements for the specified jot

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Create a new Jot Element

POST

https://jotsauce.com

/api/jots/{jot_id}/jotElements

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jot_id

string

required

The ID of the jot.

Example:

11903b26-8e9d-440e-869b-aab0a2bc97b9

Body Parameters

jottingable_type

string

required

jottingable_boolean, jottingable_date_time, jottingable_medium_text, jottingable_number, jottingable_string, jottingable_text, media.

Must be one of:

jottingable_boolean
jottingable_date_time
jottingable_medium_text
jottingable_number
jottingable_string
jottingable_text
media

Example:

jottingable_number

title

string

required

A title for your jot element.

Example:

Weight

description

string

(Optional) A description for your jot element.

Example:

Weight (in lbs.)

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "jottingable_type": "jottingable_number", "title": "Weight", "description": "Weight (in lbs.)", "order": 3 }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the specified Jot Element

GET

https://jotsauce.com

/api/jotElements/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jotElement.

Example:

3a1fe0b4-7274-418d-8c53-c65a29ca30e8

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified Jot Element

PUT

PATCH

https://jotsauce.com

/api/jotElements/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jotElement.

Example:

3a1fe0b4-7274-418d-8c53-c65a29ca30e8

Body Parameters

title

string

A title for your jot element.

Example:

Weight

description

string

(Optional) A description for your jot element.

Example:

Weight (in lbs.)

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Weight", "description": "Weight (in lbs.)", "order": 3 }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Remove the specified Jot Element

DELETE

https://jotsauce.com

/api/jotElements/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jotElement.

Example:

3a1fe0b4-7274-418d-8c53-c65a29ca30e8

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Users

Current User

GET

https://jotsauce.com

/api/users/current

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Instruments

Trashed (soft deleted) Instrument index

GET

https://jotsauce.com

/api/instruments/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Annihilate the specified Instrument

DELETE

https://jotsauce.com

/api/instruments/{instrument_id}/annihilate

requires authentication

Permanently remove Instrument from the server Only the user who created the Instrument can annihilate it

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

instrument_id

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Restore the specified trashed (soft deleted) Instrument

PUT

PATCH

https://jotsauce.com

/api/instruments/{instrument_id}/restore

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

instrument_id

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the trashed (soft deleted) Instrument

GET

https://jotsauce.com

/api/instruments/{instrument_id}/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

instrument_id

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Instrument index

GET

https://jotsauce.com

/api/instruments

requires authentication

This will only return instruments created by the user. Users do not need a list of all instruments not created by them.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/instruments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Create a new writing instrument (frontend)

POST

https://jotsauce.com

/api/instruments

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

required

Title of your instrument.

Example:

Vue Frontend

description

string

(Optional) A description of your instrument.

Example:

A frontend web app built with Vue

Auth

Bearer

Headers

Body

{ "title": "Vue Frontend", "description": "A frontend web app built with Vue" }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the Instrument

GET

https://jotsauce.com

/api/instruments/{id}

requires authentication

Any user can view any instrument given the ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified Instrument

PUT

PATCH

https://jotsauce.com

/api/instruments/{id}

requires authentication

Only the user who created the Instrument can update it

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

Body Parameters

title

string

Title of your instrument.

Example:

Vue Frontend

description

string

(Optional) A description of your instrument.

Example:

A frontend web app built with Vue

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Vue Frontend", "description": "A frontend web app built with Vue" }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Remove the specified Instrument

DELETE

https://jotsauce.com

/api/instruments/{id}

requires authentication

Only the use user who created the Instrument can delete it

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jottingables

Annihilate the specified Jottingable

DELETE

https://jotsauce.com

/api/jottingables/{jottingable_id}/annihilate

requires authentication

Permanently remove Jottingable from the server

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jottingable_id

string

required

The ID of the jottingable.

Example:

006bbcdc-b5ef-46a7-856a-225b5ecf84e9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Restore the specified trashed (soft deleted) Jottingable

PUT

PATCH

https://jotsauce.com

/api/jottingables/{jottingable_id}/restore

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jottingable_id

string

required

The ID of the jottingable.

Example:

006bbcdc-b5ef-46a7-856a-225b5ecf84e9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the trashed (soft deleted) Jottingable

GET

https://jotsauce.com

/api/jottingables/{jottingable_id}/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jottingable_id

string

required

The ID of the jottingable.

Example:

006bbcdc-b5ef-46a7-856a-225b5ecf84e9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Create a new Jottingable

POST

https://jotsauce.com

/api/jottings/{jotting_id}/jotElements/{jotElement_id}/jottingables

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotting_id

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

jotElement_id

string

required

The ID of the jotElement.

Example:

3a1fe0b4-7274-418d-8c53-c65a29ca30e8

Body Parameters

value

string

required

Value based on the jottingable_type assigned to the jot element.

Example:

160.3

Auth

Bearer

Headers

URL Parameters

Body

{ "value": 160.3 }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the specified Jottingable

GET

https://jotsauce.com

/api/jottingables/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jottingable.

Example:

006bbcdc-b5ef-46a7-856a-225b5ecf84e9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified Jottingable

PUT

PATCH

https://jotsauce.com

/api/jottingables/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jottingable.

Example:

006bbcdc-b5ef-46a7-856a-225b5ecf84e9

Body Parameters

value

string

required

Value based on the jottingable_type assigned to the jot element.

Example:

160.3

Auth

Bearer

Headers

URL Parameters

Body

{ "value": 160.3 }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Remove the specified Jottingable

DELETE

https://jotsauce.com

/api/jottingables/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the jottingable.

Example:

006bbcdc-b5ef-46a7-856a-225b5ecf84e9

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jottingable index

GET

https://jotsauce.com

/api/jottings/{jotting_id}/jottingables

requires authentication

Return a list of jottingables for the specified jotting

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotting_id

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Trashed (soft deleted) Jottingable index

GET

https://jotsauce.com

/api/jottings/{jotting_id}/jottingables/trashed

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

jotting_id

string

required

The ID of the jotting.

Example:

0057517b-2218-4904-b45a-661213391284

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Jottingable Types List

GET

https://jotsauce.com

/api/jottingableTypes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/jottingableTypes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Taggables

Taggable types list

GET

https://jotsauce.com

/api/taggableTypes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/taggableTypes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

GET

https://jotsauce.com

/api/tags/{taggableType}/{taggableId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

taggableType

string

required

Example:

sit

taggableId

string

required

Example:

facilis

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Handle the incoming request.

POST

https://jotsauce.com

/api/tags/{taggableType}/{taggableId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

taggableType

string

required

Example:

magni

taggableId

string

required

Example:

occaecati

Body Parameters

Instrument Metacontexts

Instrument Metacontextable Types List

GET

https://jotsauce.com

/api/instrumentMetacontextableTypes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/instrumentMetacontextableTypes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the specified Instrument Metacontext for metacontextable type

GET

https://jotsauce.com

/api/instrumentMetacontexts/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the instrumentMetacontext.

Example:

43b62211-f5a8-4876-988f-d806b167d8d5

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified Instrument Metacontext for metacontextable type

PUT

PATCH

https://jotsauce.com

/api/instrumentMetacontexts/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the instrumentMetacontext.

Example:

43b62211-f5a8-4876-988f-d806b167d8d5

Body Parameters

Remove the specified Instrument Metacontext for metacontextable type

DELETE

https://jotsauce.com

/api/instrumentMetacontexts/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the instrumentMetacontext.

Example:

43b62211-f5a8-4876-988f-d806b167d8d5

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Instrument Metacontext for metcontextable type

GET

https://jotsauce.com

/api/instruments/{instrument_id}/instrumentMetacontexts/{instrumentMetacontextableType}/{instrumentMetacontextableId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

instrument_id

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

instrumentMetacontextableType

string

required

Example:

43b62211-f5a8-4876-988f-d806b167d8d5

instrumentMetacontextableId

string

required

Example:

omnis

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Create a new Instrument Metacontext for metacontextable type

POST

https://jotsauce.com

/api/instruments/{instrument_id}/instrumentMetacontexts/{instrumentMetacontextableType}/{instrumentMetacontextableId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

instrument_id

string

required

The ID of the instrument.

Example:

00000000-0000-0000-0000-000000000000

instrumentMetacontextableType

string

required

Example:

43b62211-f5a8-4876-988f-d806b167d8d5

instrumentMetacontextableId

string

required

Example:

iste

Body Parameters

Compositionables

Compositionable Types List

GET

https://jotsauce.com

/api/compositionableTypes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://jotsauce.com/api/compositionableTypes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Create a new Compositionable

POST

https://jotsauce.com

/api/compositions/{composition_id}/compositionables

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Body Parameters

compositionable_type

string

required

jot, jotting.

Must be one of:

jot
jotting

Example:

jot

compositionable_id

string

required

ID of the jot or jotting. Must be a valid UUID.

Example:

fbc0ac70-c79f-34b0-a7e2-3fd6fbd2fc86

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "compositionable_type": "jot", "compositionable_id": "fbc0ac70-c79f-34b0-a7e2-3fd6fbd2fc86", "order": 3 }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Return the specified Compositionable

GET

https://jotsauce.com

/api/compositionables/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the compositionable.

Example:

510a78c5-38a2-41b4-99f6-2f84f6ad5c33

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Update the specified Compositionable

PUT

PATCH

https://jotsauce.com

/api/compositionables/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the compositionable.

Example:

510a78c5-38a2-41b4-99f6-2f84f6ad5c33

Body Parameters

order

integer

(Optional) The order in which you want this composition to list. Must be at least 1.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "order": 3 }

Received response

Example request:

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

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Remove the specified Compositionable

DELETE

https://jotsauce.com

/api/compositionables/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the compositionable.

Example:

510a78c5-38a2-41b4-99f6-2f84f6ad5c33

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}

Compositionable index

GET

https://jotsauce.com

/api/compositions/{composition_id}/compositionables

requires authentication

Return a list of compositionables for the specified composition

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

composition_id

string

required

The ID of the composition.

Example:

0cfd5dad-5497-4695-82aa-283e67b0838e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "success": false,
    "message": "Unauthenticated.",
    "data": []
}