LinkReference
v1.0.0
OAS 3.0.3

Blinko CRUD API V1

blinko api for public endpoints

Server: /api
Client Libraries

Note

​
Note Operations

Query notes list

​
Body
  • tagId
    Type:number | nullable
    default: 
  • page
    Type:number
    default: 
    1
  • size
    Type:number
    default: 
    30
  • orderBy
    Type:string enum
    default: 
    desc
    • asc
    • desc
  • type
    anyOf
  • isArchived
    Type:boolean | nullable
    default: 
    false
  • isShare
    Type:boolean | nullable
    default: 
  • isRecycle
    Type:boolean
    default: 
    false
  • searchText
    Type:string
    default: 
  • withoutTag
    Type:boolean
    default: 
    false
  • withFile
    Type:boolean
    default: 
    false
  • withLink
    Type:boolean
    default: 
    false
  • isUseAiQuery
    Type:boolean
    default: 
    false
  • startDate
    Type:string | nullable
    default: 
  • endDate
    Type:string | nullable
    default: 
  • hasTodo
    Type:boolean
    default: 
    false
Responses
Request Example forPOST/v1/note/list
curl /api/v1/note/list \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "tagId": null,
  "page": 1,
  "size": 30,
  "orderBy": "desc",
  "type": -1,
  "isArchived": false,
  "isShare": null,
  "isRecycle": false,
  "searchText": "",
  "withoutTag": false,
  "withFile": false,
  "withLink": false,
  "isUseAiQuery": false,
  "startDate": null,
  "endDate": null,
  "hasTodo": false
}'

[
  {
    "id": 1,
    "type": 1,
    "content": "…",
    "isArchived": true,
    "isRecycle": true,
    "isShare": true,
    "isTop": true,
    "isReviewed": true,
    "sharePassword": "…",
    "shareEncryptedUrl": null,
    "shareExpiryDate": null,
    "shareMaxView": null,
    "shareViewCount": null,
    "metadata": null,
    "accountId": 1,
    "createdAt": "…",
    "updatedAt": "…",
    "attachments": [
      {
        "id": 1,
        "isShare": true,
        "sharePassword": "…",
        "name": "…",
        "path": "…",
        "size": null,
        "noteId": null,
        "accountId": null,
        "createdAt": "…",
        "sortOrder": 1,
        "updatedAt": "…",
        "type": "…",
        "depth": null,
        "perfixPath": null
      }
    ],
    "tags": [
      {
        "id": 1,
        "noteId": 1,
        "tagId": 1,
        "tag": {
          "id": 1,
          "name": "…",
          "icon": "…",
          "parent": 1,
          "sortOrder": 1,
          "createdAt": "…",
          "updatedAt": "…"
        }
      }
    ],
    "references": [
      {
        "toNoteId": 1,
        "toNote": {
          "content": "…",
          "createdAt": "…",
          "updatedAt": "…"
        }
      }
    ],
    "referencedBy": [
      {
        "fromNoteId": 1,
        "fromNote": {
          "content": "…",
          "createdAt": "…",
          "updatedAt": "…"
        }
      }
    ],
    "_count": {
      "comments": 1,
      "histories": 1
    }
  }
]

Successful response

User (Collapsed)

​
User Operations

Task (Collapsed)

​
Task Operations

Models