Cards
Get Specified Cards
Cards
Collections
Friends
Api Keys
Members
Profiles
Review
Share
User
- PATCHSet Preferences
- PUTSet Preference Flag
- PUTSet Feature Preview Flag
- GETGet User Email Addresses
- GETGet Email
- DELDelete Email
- PUTMake Email Primary
- GETCheck Auth
- GETCheck If Fresh Access Token
- GETGet Current User
- PUTUpdate Current User
- PUTUpdate Current User Bio And Pic
- GETGet Pins
- PUTUpdate Pins
Cards
Get Specified Cards
Get the full card memberships of all the card IDs passed in the request body
NOTE: This is a “POST-GET” endpoint – the method is POST (for the payload) but it GETs data
POST
/
v1
/
cards
/
get
/
specify
curl --request POST \
--url https://api.supernotes.app/v1/cards/get/specify \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '[
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]'
{
"[card_id]": {
"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,
"broadsheet_cols": 123
},
"visibility": -1,
"status": -2,
"total_child_count": 123,
"share_link_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
Body
application/json · string[]
The body is of type string[]
.
Response
200
application/json
Successful Response
Available options:
blue
, green
, orange
, pink
, purple
, red
, yellow
Available options:
blue
, green
, orange
, pink
, purple
, red
, yellow
Available options:
-1
, 0
, 1318
, 1382
, 1398
, 4094
, 8190
Available options:
0
, 1
, 2
, 3
Available options:
1
, 2
, 4
Available options:
0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
Available options:
-1
, 0
, 1
Available options:
-2
, -1
, 0
, 1
, 2
Available options:
-1
, 0
, 1318
, 1382
, 1398
, 4094
, 8190
Available options:
-2
, -1
, 0
, 1
, 2
curl --request POST \
--url https://api.supernotes.app/v1/cards/get/specify \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '[
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]'
{
"[card_id]": {
"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,
"broadsheet_cols": 123
},
"visibility": -1,
"status": -2,
"total_child_count": 123,
"share_link_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
}
}
}
}