Get the authenticated user’s pins
curl --request GET \
--url https://api.supernotes.app/v1/user/pins \
--header 'Api-Key: <api-key>'
{
"[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",
"link_cache": {},
"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,
"attempt_card_match": true
},
"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
}
}
}
}
Successful Response
The response is of type object
.
curl --request GET \
--url https://api.supernotes.app/v1/user/pins \
--header 'Api-Key: <api-key>'
{
"[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",
"link_cache": {},
"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,
"attempt_card_match": true
},
"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
}
}
}
}
Get the authenticated user’s pins
curl --request GET \
--url https://api.supernotes.app/v1/user/pins \
--header 'Api-Key: <api-key>'
{
"[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",
"link_cache": {},
"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,
"attempt_card_match": true
},
"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
}
}
}
}
Successful Response
The response is of type object
.
curl --request GET \
--url https://api.supernotes.app/v1/user/pins \
--header 'Api-Key: <api-key>'
{
"[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",
"link_cache": {},
"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,
"attempt_card_match": true
},
"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
}
}
}
}