Sign in

v1

latestOpenAPI 3.0.12026-07-2471156164.1 KB
Search

Search for cards

A maximum of 50 cards will be returned. If more than 50 cards exist, a link to the next page of results will be included in the Link header

get/api/v1/search/cardmgr

Query parameters

qstring

Query String

searchTermsstring
queryType'cards' | 'questions' | 'archived' | 'draft' | 'legacy' | 'search_cards'
showArchivedboolean

Include archived cards

maxResultsinteger

Maximum results

sortField'lastModified' | 'lastModifiedBy' | 'boardCount' | 'verificationState' | 'copyCount' | 'viewCount' | 'favoriteCount' | 'followerCount' | 'dateCreated' | 'verificationInterval' | 'verifier' | 'owner' | 'originalOwner' | 'lastVerifiedBy' | 'lastVerified' | 'verificationReason' | 'popularity' | 'unverifiedViewsCopies' | 'nextVerificationDate' | 'collection' | 'title' | 'followedDate' | 'pendingAutoArchive' | 'relevancy'

Sort field

sortOrder'ASC' | 'DESC'

Sort order

tokenstring

Paging token

Headers

X-Guru-ActivitySubTypestring

Response

successful operation

idstring

ID of the Card

contentstring required

The Card's HTML or Markdown content

lastModifiedstring date-time

Date the Card was last modified

versioninteger

Current version of the Card. As the card gets updated and revised, the version number will increase.

verificationType'ABSOLUTE' | 'RELATIVE'

Whether the card's verification date is ABSOLUTE or RELATIVE

slugstring

The slug is the URL address to the card

favoritedDatestring date-time

Date when this card has been favorited by the current user

favoritedboolean

Whether this card has been favorited by the current user

publicLinkAllowedboolean
archivedboolean

Indicates if the Card has been archived

cardType'CARD' | 'QUESTION'

The type of the Card. CARD for content cards, QUESTION for Questions.

nextVerificationDatestring date-time

Next date that this Card needs verification dependent on verification interval

lastViewedstring date-time

Last time the card was viewed

verificationReasonsstring[]
commentCountinteger

Number of comments on the card

suppressVerificationboolean

Flag for enabling card verification on save

verificationInitiationDatestring date-time

Date corresponding to the action that unverified the card

cardTemplateIdstring

ID of the template from which this card was created if applicable

folderCountinteger

The number of folders this card is in

answerIdstring
commentsEnabledboolean

A flag to indicate if comments are allowed on this Card

pendingAutoArchiveboolean

A flag to indicate if this unverified card is currently in an auto archive queue

settingsUpdateboolean

A flag to indicate if the changes are only updating the settings of the card

lastVerifiedstring date-time

Date the Card was last verified

preferredPhrasestring required

The title of the Card

shareStatus'PRIVATE' | 'TEAM' | 'PUBLIC'

The share status of the Card. TEAM for team shared cards and PRIVATE for privately shared cards

dateCreatedstring date-time

Date the Card was created

verificationIntervalinteger

Time interval (in days), indicating the frequency that this card needs re-verification. Passing in null will default to 30 days.

verificationState'TRUSTED' | 'STALE' | 'NEEDS_VERIFICATION' | 'SYNCED_NO_VERIFICATION'

Whether the card is TRUSTED, STALE, or NEEDS_VERIFICATION

verificationReason'UPDATE' | 'NEW_VERIFIER' | 'QUESTION' | 'REQUESTED' | 'EXPIRED'

Reason this card needs verification. UPDATE if this card was updated by a user that is not the verifier. NEW_VERIFIER if this card was assigned to a new verifier but has not yet been verified. This value will only be present if the verification state is NEEDS_VERIFICATION