Share
Find Card With Share Code
- GETGet Card
- POSTGet Selected Cards
- POSTGet Specified Cards
- POSTGet Cards Since
- GETGet Deleted Cards
- POSTSimple Create Card
- POSTCreate Cards
- PATCHUpdate Cards
- PUTEnroll In Card
- POSTRemove Cards For Me
- POSTDelete Cards For Everyone
- PATCHSet Preferences
- PUTSet Preference Flag
- PUTSet Feature Preview Flag
- GETCheck Auth
- GETCheck If Fresh Access Token
- GETGet Current User
- PUTUpdate Current User
- PUTUpdate Current User Bio And Pic
- GETGet Pins
- PUTPut Pins
- GETGet Current User Profile
- GETGet Known Owner Profiles
- GETGet Other User Profile
- POSTGet Specified User Profiles
- GETGet Members
- POSTAttempt Join
- POSTInvite Member
- PUTRespond To Invite
- PUTModify Member
- DELDelete Member
- GETGet Friends
- POSTSend Friend Request
- GETGet Incoming Requests
- GETGet Outgoing Requests
- PUTAccept Friendship
- DELDelete Friendship
- GETGet Share Codes For Card
- POSTCreate Share Code
- PUTUpdate Share Code
- DELDelete Share Code
- GETFind Card With Share Code
- GETAuthed Find Card With Share Code
- POSTJoin Card With Share Code
Cards
User
Profiles
Members
Friends
Share
Share
Find Card With Share Code
Retrieve card data (and share code metadata) by specifying a share code.
GET
/
v1
/
sharing
/
code
/
{code}
Api-Key
string
*
Api-Key
Required
string
code
Code · string
*
code
Required
string
curl --request GET \
--url https://api.supernotes.app/v1/sharing/code/{code}
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"granted_perms": -1,
"card": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"html": "<string>",
"color": "blue",
"icon": "<string>",
"tags": [
"<string>"
],
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_when": "2023-11-07T05:31:56Z",
"modified_when": "2023-11-07T05:31:56Z",
"owner": {
"first_name": "<string>",
"last_name": "<string>"
},
"trusted": true,
"likes": 123,
"comment_count": 123,
"public_child_count": 123
}
}
Path Parameters
code
string
requiredResponse
200 - application/json
id
string
requiredcard_id
string
requiredowner_id
string
requiredcode
string
requiredgranted_perms
enum<integer>
requiredAvailable options:
-1
, 0
, 1318
, 1382
, 1398
, 4094
, 8190
card
object
requiredcard.id
string
requiredcard.name
string
requiredcard.html
string
requiredcard.color
enum<string> | null
requiredAvailable options:
blue
, green
, orange
, pink
, purple
, red
, yellow
card.icon
string | null
requiredcard.tags
string[]
requiredcard.owner_id
string
requiredcard.created_when
string
requiredcard.modified_when
string
requiredcard.owner
object
requiredcard.owner.first_name
string
requiredcard.owner.last_name
string
requiredcard.trusted
boolean
requiredcard.likes
integer
requiredcard.comment_count
integer
requiredcard.public_child_count
integer
requiredcurl --request GET \
--url https://api.supernotes.app/v1/sharing/code/{code}
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"granted_perms": -1,
"card": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"html": "<string>",
"color": "blue",
"icon": "<string>",
"tags": [
"<string>"
],
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_when": "2023-11-07T05:31:56Z",
"modified_when": "2023-11-07T05:31:56Z",
"owner": {
"first_name": "<string>",
"last_name": "<string>"
},
"trusted": true,
"likes": 123,
"comment_count": 123,
"public_child_count": 123
}
}