Skip to content

List cards

GET/v1/cards
Authorization
AuthorizationBearer token (OAuth access token or teakapi_ API key) · headerrequired

Bearer token. Accepts either an OAuth 2.0 access token (obtained via browser sign-in; expires after 1 hour and is refreshable) or a teakapi_ API key.

Query parameters
qstring
limitinteger
cursorstring
sortstring
Allowed:newestoldest
typestring
Allowed:textlinkimagevideoaudiodocumentpalettequote
tagstring
favoritedboolean
createdAfternumber
createdBeforenumber
includestring

Comma-separated values: content, metadata, processing

Responses
200

Paginated card list

itemsCardListItem[]required
Show properties
Array of CardListItem
aiSummarystring | null
aiTagsstring[]required
appUrlstring<uri>required
compactUrlstring | null

256px rendition URL for small cards; present for image uploads.

contentstring
createdAtnumberrequired
detailUrlstring | null
fileNamestring | null
fileSizenumber | null
mimeTypestring | null
fileExtensionstring | null
fileKindstring | null
fileLanguagestring | null
filePreviewobject | null
fileUrlstring | null
idstringrequired
isFavoritedbooleanrequired
linkPreviewImageUrlstring | null
metadataDescriptionstring | null
metadataTitlestring | null
notesstring | null
placeholderUrlstring | null

48px loading-placeholder rendition URL; present for image uploads.

processingStatusstring | null
screenshotUrlstring | null
tagsstring[]required
thumbnailUrlstring | null
typestringrequired
updatedAtnumberrequired
urlstring | null
pageInfoCardPageInforequired
Show properties
hasMorebooleanrequired
nextCursorstring | nullrequired
totalnumber
400

Invalid request

codestringrequired
detailsobject | null
errorstringrequired
requestIdstring | null
retryAtnumber | null
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://teakvault.com/api/v1/cards" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "items": [
    {
      "aiSummary": "string",
      "aiTags": [
        "string"
      ],
      "appUrl": "http://example.com",
      "compactUrl": "string",
      "content": "string",
      "createdAt": 0,
      "detailUrl": "string",
      "fileName": "string",
      "fileSize": 0,
      "mimeType": "string",
      "fileExtension": "string",
      "fileKind": "string",
      "fileLanguage": "string",
      "filePreview": {},
      "fileUrl": "string",
      "id": "string",
      "isFavorited": true,
      "linkPreviewImageUrl": "string",
      "metadataDescription": "string",
      "metadataTitle": "string",
      "notes": "string",
      "placeholderUrl": "string",
      "processingStatus": "string",
      "screenshotUrl": "string",
      "tags": [
        "string"
      ],
      "thumbnailUrl": "string",
      "type": "string",
      "updatedAt": 0,
      "url": "string"
    }
  ],
  "pageInfo": {
    "hasMore": true,
    "nextCursor": "string"
  },
  "total": 0
}