> For the complete documentation index, see [llms.txt](https://docs.ipaper.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ipaper.io/flipbook-backend-api/link/get-links.md).

# GetLinks

## Description

Exports all links from a given iPaper.

{% hint style="info" %}
**Note:**

Superfluous nodes will be removed later on. Thus, for example, a rectangle link will in the future not include the polygoncoords node. When reading the response, you should handle potential missing nodes and degrade gracefully.
{% endhint %}

## Parameters

| Name    | Value                                               |
| ------- | --------------------------------------------------- |
| paperID | The ID of the iPaper whose links should be returned |

## Sample Response

```xml
<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></ code>
  <message><![CDATA[Links exported.]]></message>
  <data>
    <root>
      <link number="1">
        <number><![CDATA[2]]></number>
        <x><![CDATA[0.277648839556004]]></x>
        <y><![CDATA[0.231397006414825]]></y>
        <width><![CDATA[0.0671285252555119]]></width>
        <height><![CDATA[0.0132451983038164]]></height>
        <alttext><![CDATA[]]></alttext>
        <url><![CDATA[]]></url>
        <stylename><![CDATA[1']]></stylename>
        <shapetype><![CDATA[rectangle]]></shapetype>
        <polygoncoords><![CDATA[]]></polygoncoords>
        <linktype><![CDATA[shopitem]]></linktype>
        <fileid><![CDATA[]]></fileid>
        <target><![CDATA[]]></target>
        <usemask><![CDATA[True]]></usemask>
        <param><![CDATA[<item><name><![CDATA[FIBERROND. 3M 581C Ø127x22MM P60]]></name><price><![CDATA[2.75]]></price><descr><![CDATA[]]></descr><id><![CDATA[9900002430]]></id></item>]]></param>
      </link>
      <link number="2">
        <number><![CDATA[2]]></number>
        <x><![CDATA[0.114934409687185]]></x>
        <y><![CDATA[0.331147540983607]]></y>
        <width><![CDATA[0.0671285252555116]]></width>
        <height><![CDATA[0.0132451983038164]]></height>
        <alttext><![CDATA[]]></alttext>
        <url><![CDATA[]]></url>
        <stylename><![CDATA[1']]></stylename>
        <shapetype><![CDATA[rectangle]]></shapetype>
        <polygoncoords><![CDATA[]]></polygoncoords>
        <linktype><![CDATA[shopitem]]></linktype>
        <fileid><![CDATA[]]></fileid>
        <target><![CDATA[]]></target>
        <usemask><![CDATA[True]]></usemask>
        <param><![CDATA[<item><name><![CDATA[FIBERROND. 3M 581C Ø127X22MM P50]]></name><price><![CDATA[2.75]]></price><descr><![CDATA[]]></descr><id><![CDATA[9900002429]]></id></item>]]></param>
      </link>
</result>
```

## Return Codes

* SUCCESS
* ERROR


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ipaper.io/flipbook-backend-api/link/get-links.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
