Skip to main content

GET /links

Description​

Retrieves information about all links and returns a JSON object containing an array of link objects.

This endpoint responds to HTTP GET requests sent to the /links path.

Payload​

No payload needs to be sent with this request.

Response​

The response includes a JSON object with an array of all link objects.

Example:

[
    {
        "id": 1,
        "masterId": 2,
        "slaveId": 5,
        "relation": "relatesTo",
    },
    {
        "id": 2,
        "masterId": 4,
        "slaveId": 9,
        "relation": "relatesTo",
    },
]

For another example of the returned object, see links.

The HTTP status code indicates whether the request was successful (response.status == 200) or encountered an error (response.status == 500).

Related articles: