Cards
Create 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
Create Cards
Create cards with full control over properties
POST
/
v1
/
cards
Api-Key
string
*
Api-Key
Required
string
Cards · object
*
[card_id]
PostCard · object
[card_id]
object
data
PostCardData · object
*
data
Required
object
id
Id · string
*
id
Required
string
name
Name · string
name
string
markup
Markup · string
markup
string
html
Html · string
html
string
ydoc
string
ydoc
string
icon
string
icon
string
color
enum<string>
color
enum<string>
created_when
string
created_when
string
modified_when
string
modified_when
string
targeted_when
string
targeted_when
string
meta
object
meta
object
import_id
string
import_id
string
tags
Tags · array
tags
array
source
string
source
string
membership
PostCardMembership · object
*
membership
Required
object
id
Id · string
*
id
Required
string
personal_color
enum<string>
personal_color
enum<string>
personal_tags
Personal Tags · array
personal_tags
array
created_when
string
created_when
string
liked
boolean
liked
boolean
visibility
integer
visibility
integer
view
object
view
object
display_type
ViewDisplayType · enum<integer>
*
display_type
Required
enum<integer>
sort_type
SortType · enum<integer>
*
sort_type
Required
enum<integer>
sort_ascending
Sort Ascending · boolean
*
sort_ascending
Required
boolean
parents
Parents · object
parents
object
[card_id]
UpsertCardParent · object
[card_id]
object
publishing_perms
enum<integer>
publishing_perms
enum<integer>
created_when
string
created_when
string
archived
boolean
archived
boolean
cutting
boolean
cutting
boolean
Authorizations
Api-Key
string
headerrequiredBody
application/json
[card_id]
object
[card_id].data
object
required[card_id].data.id
string
required[card_id].data.name
string
default: [card_id].data.markup
string
default: [card_id].data.html
string
default: [card_id].data.ydoc
string | null
[card_id].data.icon
string | null
[card_id].data.color
enum<string> | null
Available options:
blue, green, orange, pink, purple, red, yellow [card_id].data.created_when
string | null
[card_id].data.modified_when
string | null
[card_id].data.targeted_when
string | null
[card_id].data.meta
object | null
[card_id].data.import_id
string | null
[card_id].data.tags
string[]
[card_id].data.source
string | null
[card_id].membership
object
required[card_id].membership.id
string
required[card_id].membership.personal_color
enum<string> | null
Available options:
blue, green, orange, pink, purple, red, yellow [card_id].membership.personal_tags
string[]
[card_id].membership.created_when
string | null
[card_id].membership.liked
boolean | null
[card_id].membership.visibility
integer | null
[card_id].membership.view
object | null
[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].parents
object
[card_id].parents.[card_id]
object
[card_id].parents.[card_id].publishing_perms
enum<integer> | null
Available options:
-1, 0, 1318, 1382, 1398, 4094, 8190 [card_id].parents.[card_id].created_when
string | null
[card_id].parents.[card_id].archived
boolean | null
[card_id].parents.[card_id].cutting
boolean | null
Response
200 - application/json
The response is of type object.