Cards
Get Selected 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 Selected Cards
The “base query” for retrieving cards (memberships) – supports selecting, filtering, and ordering by any implemented metric
NOTE: This is a “POST-GET” endpoint – the method is POST (for the payload) but it GETs data
POST
/
v1
/
cards
/
get
/
select
Api-Key
string
*
Api-Key
Required
string
ExtendedSelectCriteria · object
*
include_membership_statuses
array
include_membership_statuses
array
parent_id
string
parent_id
string
search
string
search
string
filter_group
object
filter_group
object
operator
FilterGroupOperator · enum<string>
*
operator
Required
enum<string>
include
array
include
array
exclude
array
exclude
array
changed_since
string
changed_since
string
targeted_or_created_when
object
targeted_or_created_when
object
from_when
From When · string
from_when
string
to_when
To When · string
to_when
string
created_when
object
created_when
object
from_when
From When · string
from_when
string
to_when
To When · string
to_when
string
modified_when
object
modified_when
object
from_when
From When · string
from_when
string
to_when
To When · string
to_when
string
sort_type
enum<integer>
sort_type
enum<integer>
sort_ascending
boolean
sort_ascending
boolean
limit
integer
limit
integer
Authorizations
Api-Key
string
headerrequiredBody
application/json
include_membership_statuses
enum<integer>[] | null
Available options:
-2
, -1
, 0
, 1
, 2
parent_id
string | null
search
string | null
filter_group
object | null
filter_group.operator
enum<string>
requiredAvailable options:
and
, or
include
string[] | null
exclude
string[] | null
changed_since
string | null
targeted_or_created_when
object | null
targeted_or_created_when.from_when
string
targeted_or_created_when.to_when
string
created_when
object | null
created_when.from_when
string
created_when.to_when
string
modified_when
object | null
modified_when.from_when
string
modified_when.to_when
string
sort_type
enum<integer> | null
Available options:
0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
sort_ascending
boolean | null
limit
integer | null
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