List outgoing links

GET/v1/documents/{id}/links

Lists the links in this document (body first, then properties, in document order), each with the live document it resolves to or null.

docs:readRead-only

Request

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

Path parameters

idULIDrequired

Response

linksOutgoingLink[]
Show 9 fieldsHide fields
- idULID
- kindstring
  One oflinkembed
- syntaxstring
  One ofwikilinkmarkdown
- targetRefstring
  The link target as written (path or title, without #part).
- targetHeadingstringor null
- targetBlockIdstringor null
- sourceBlockIdstringor null
- sourcePropertystringor nulloptional
- targetobjector null
  The live document it resolves to; null when it resolves to nothing or to the trash.
  Show 4 fieldsHide fields
  idULID
  titlestring· 1–255 chars
  parentIdULIDor null
  workspaceIdstring· 1–64 chars

200

{
  "links": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "kind": "link",
      "syntax": "wikilink",
      "targetRef": "string",
      "targetHeading": null,
      "targetBlockId": null,
      "sourceBlockId": null,
      "sourceProperty": null,
      "target": null
    }
  ]
}

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