Members
Attempt Join
- 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
Members
Attempt Join
Attempt to join a card (based on having access to some arbitrary ancestor card)
POST
/
v1
/
members
/
{card_id}
/
attempt-join
Api-Key
string
*
Api-Key
Required
string
card_id
Card Id · string
*
card_id
Required
string
curl --request POST \
--url https://api.supernotes.app/v1/members/{card_id}/attempt-join
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"markup": "<string>",
"html": "<string>",
"ydoc": "<string>",
"icon": "<string>",
"tags": [
"<string>"
],
"color": "blue",
"created_when": "2023-11-07T05:31:56Z",
"modified_when": "2023-11-07T05:31:56Z",
"modified_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"synced_when": "2023-11-07T05:31:56Z",
"meta": {},
"targeted_when": "2023-11-07T05:31:56Z",
"comment_count": 123,
"likes": 123,
"member_count": 123,
"public_child_count": 123
},
"membership": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"liked": true,
"personal_tags": [
"<string>"
],
"personal_color": "blue",
"perms": -1,
"via_type": 0,
"via_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_when": "2023-11-07T05:31:56Z",
"modified_when": "2023-11-07T05:31:56Z",
"enrolled_when": "2023-11-07T05:31:56Z",
"opened_when": "2023-11-07T05:31:56Z",
"auto_publish_children": true,
"view": {
"display_type": 1,
"sort_type": 0,
"sort_ascending": true
},
"visibility": -1,
"status": -2,
"total_child_count": 123
},
"backlinks": [
"<string>"
],
"parents": {
"[card_id]": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"child_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_when": "2023-11-07T05:31:56Z",
"publishing_perms": -1,
"archived": true,
"parent_membership_status": -2
}
}
}
Authorizations
Api-Key
string
headerrequiredPath Parameters
card_id
string
requiredResponse
200 - application/json
data
object
requireddata.id
string
requireddata.owner_id
string
requireddata.name
string
requireddata.markup
string
requireddata.html
string
requireddata.ydoc
string
requireddata.icon
string | null
requireddata.tags
string[]
requireddata.color
enum<string> | null
requiredAvailable options:
blue
, green
, orange
, pink
, purple
, red
, yellow
data.created_when
string
requireddata.modified_when
string
requireddata.modified_by_id
string
requireddata.synced_when
string
requireddata.meta
object
requireddata.targeted_when
string | null
requireddata.comment_count
integer
requireddata.likes
integer
requireddata.member_count
integer
requireddata.public_child_count
integer
requiredmembership
object
requiredmembership.id
string
requiredmembership.liked
boolean | null
requiredmembership.personal_tags
string[]
requiredmembership.personal_color
enum<string> | null
requiredAvailable options:
blue
, green
, orange
, pink
, purple
, red
, yellow
membership.perms
enum<integer>
requiredAvailable options:
-1
, 0
, 1318
, 1382
, 1398
, 4094
, 8190
membership.via_type
enum<integer>
requiredAvailable options:
0
, 1
, 2
, 3
membership.via_id
string | null
requiredmembership.created_when
string
requiredmembership.modified_when
string
requiredmembership.enrolled_when
string | null
requiredmembership.opened_when
string | null
requiredmembership.auto_publish_children
boolean | null
requiredmembership.view
object | null
requiredmembership.view.display_type
enum<integer>
requiredAvailable options:
1
, 2
, 4
membership.view.sort_type
enum<integer>
requiredAvailable options:
0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
membership.view.sort_ascending
boolean
requiredmembership.visibility
enum<integer>
requiredAvailable options:
-1
, 0
, 1
membership.status
enum<integer>
requiredAvailable options:
-2
, -1
, 0
, 1
, 2
membership.total_child_count
integer
requiredbacklinks
string[]
requiredparents
object
requiredparents.[card_id]
object
parents.[card_id].id
string
requiredparents.[card_id].owner_id
string
requiredparents.[card_id].parent_id
string
requiredparents.[card_id].child_id
string
requiredparents.[card_id].created_when
string
requiredparents.[card_id].publishing_perms
enum<integer> | null
requiredAvailable options:
-1
, 0
, 1318
, 1382
, 1398
, 4094
, 8190
parents.[card_id].archived
boolean | null
requiredparents.[card_id].parent_membership_status
enum<integer>
requiredAvailable options:
-2
, -1
, 0
, 1
, 2
curl --request POST \
--url https://api.supernotes.app/v1/members/{card_id}/attempt-join
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"markup": "<string>",
"html": "<string>",
"ydoc": "<string>",
"icon": "<string>",
"tags": [
"<string>"
],
"color": "blue",
"created_when": "2023-11-07T05:31:56Z",
"modified_when": "2023-11-07T05:31:56Z",
"modified_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"synced_when": "2023-11-07T05:31:56Z",
"meta": {},
"targeted_when": "2023-11-07T05:31:56Z",
"comment_count": 123,
"likes": 123,
"member_count": 123,
"public_child_count": 123
},
"membership": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"liked": true,
"personal_tags": [
"<string>"
],
"personal_color": "blue",
"perms": -1,
"via_type": 0,
"via_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_when": "2023-11-07T05:31:56Z",
"modified_when": "2023-11-07T05:31:56Z",
"enrolled_when": "2023-11-07T05:31:56Z",
"opened_when": "2023-11-07T05:31:56Z",
"auto_publish_children": true,
"view": {
"display_type": 1,
"sort_type": 0,
"sort_ascending": true
},
"visibility": -1,
"status": -2,
"total_child_count": 123
},
"backlinks": [
"<string>"
],
"parents": {
"[card_id]": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"child_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_when": "2023-11-07T05:31:56Z",
"publishing_perms": -1,
"archived": true,
"parent_membership_status": -2
}
}
}