List backlinks

GET/v1/documents/{id}/backlinks

Lists live documents that link to this document.

Request

curl "https://api.lydie.co/v1/documents/01JCQ3V5MZ8G4ZK2X7T9R6N1PB/backlinks" \
  -H "Authorization: Bearer $LYDIE_TOKEN"

Path parameters

idULIDrequired

Response

backlinksBacklink[]
Show 8 fieldsHide fields
- sourceobject
  Show 4 fieldsHide fields
  idULID
  titlestring· 1–255 chars
  parentIdULIDor null
  workspaceIdstring· 1–64 chars
- kindstring
  One oflinkembed
- syntaxstring
  One ofwikilinkmarkdown
- targetRefstring
- sourceBlockIdstringor null
- targetHeadingstringor null
- targetBlockIdstringor null
- sourcePropertystringor nulloptional
  Set when the link is in a property (a relation value or a [[link]]).

200

{
  "backlinks": [
    {
      "source": {
        "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
        "title": "Meeting notes",
        "parentId": null,
        "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA"
      },
      "kind": "link",
      "syntax": "wikilink",
      "targetRef": "string",
      "sourceBlockId": null,
      "targetHeading": null,
      "targetBlockId": null,
      "sourceProperty": null
    }
  ]
}

Errors use one envelope for every endpoint. See Errors and versions.