Cards
Get Specified Cards
- 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
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
Api-Key
string
*
Api-Key
Required
string
Specified · array
*
Authorizations
Api-Key
string
headerrequiredBody
application/json · string[]
The body is of type string[].
Response
200 - application/json
[card_id]
object
[card_id].data
object
required[card_id].data.id
string
required[card_id].data.owner_id
string
required[card_id].data.name
string
required[card_id].data.markup
string
required[card_id].data.html
string
required[card_id].data.ydoc
string
required[card_id].data.icon
string | null
required[card_id].data.tags
string[]
required[card_id].data.color
enum<string> | null
requiredAvailable options:
blue, green, orange, pink, purple, red, yellow [card_id].data.created_when
string
required[card_id].data.modified_when
string
required[card_id].data.modified_by_id
string
required[card_id].data.synced_when
string
required[card_id].data.meta
object
required[card_id].data.targeted_when
string | null
required[card_id].data.comment_count
integer
required[card_id].data.likes
integer
required[card_id].data.member_count
integer
required[card_id].data.public_child_count
integer
required[card_id].membership
object
required[card_id].membership.id
string
required[card_id].membership.liked
boolean | null
required[card_id].membership.personal_tags
string[]
required[card_id].membership.personal_color
enum<string> | null
requiredAvailable options:
blue, green, orange, pink, purple, red, yellow [card_id].membership.perms
enum<integer>
requiredAvailable options:
-1, 0, 1318, 1382, 1398, 4094, 8190 [card_id].membership.via_type
enum<integer>
requiredAvailable options:
0, 1, 2, 3 [card_id].membership.via_id
string | null
required[card_id].membership.created_when
string
required[card_id].membership.modified_when
string
required[card_id].membership.enrolled_when
string | null
required[card_id].membership.opened_when
string | null
required[card_id].membership.auto_publish_children
boolean | null
required[card_id].membership.view
object | null
required[card_id].membership.view.display_type
enum<integer>
requiredAvailable options:
1, 2, 4 [card_id].membership.view.sort_type
enum<integer>
requiredAvailable options:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 [card_id].membership.view.sort_ascending
boolean
required[card_id].membership.visibility
enum<integer>
requiredAvailable options:
-1, 0, 1 [card_id].membership.status
enum<integer>
requiredAvailable options:
-2, -1, 0, 1, 2 [card_id].membership.total_child_count
integer
required[card_id].backlinks
string[]
required[card_id].parents
object
required[card_id].parents.[card_id]
object
[card_id].parents.[card_id].id
string
required[card_id].parents.[card_id].owner_id
string
required[card_id].parents.[card_id].parent_id
string
required[card_id].parents.[card_id].child_id
string
required[card_id].parents.[card_id].created_when
string
required[card_id].parents.[card_id].publishing_perms
enum<integer> | null
requiredAvailable options:
-1, 0, 1318, 1382, 1398, 4094, 8190 [card_id].parents.[card_id].archived
boolean | null
required[card_id].parents.[card_id].parent_membership_status
enum<integer>
requiredAvailable options:
-2, -1, 0, 1, 2