Skip to main content

Links

This page contains information about the /links endpoint, which is used to manage your links.

info

This endpoint requires authentication and the links scope.

Get a link by its ID.

Request​

:id is the ID of the link you want to get.

GET /api/links/:id

Example Response​

{
  "id": "bd0e4bc2-f7ef-460a-a99e-f4976535d540",
  "type": "last.fm",
  "value": "ItsYuuto"
}

Create a new link.

Request​

POST /api/links
Content-Type: application/json

Example body:

{
  "type": "steam",
  "value": "id/PasYuuto"
}

Example Response​

Returns a 201 status on success, and the link object in the response body.

{
  "id": "5675e563-0fd3-419b-947f-d95e507f673b",
  "type": "steam",
  "value": "id/PasYuuto"
}

Update a link by its ID.

Request​

:id is the ID of the link you want to update.

PATCH /api/links/:id
Content-Type: application/json

Example body:

{
  "value": "id/Yuuto"
}

Example Response​

Returns a 200 status on success, and the updated link object in the response body.

{
  "id": "5675e563-0fd3-419b-947f-d95e507f673b",
  "type": "steam",
  "value": "id/Yuuto"
}

Delete a link by its ID.

Request​

:id is the ID of the link you want to delete. Obviously, you can only delete your own links.

DELETE /api/links/:id

Example Response​

Returns:

  • a 204 status on success.
  • a 404 status if the link does not exist.
  • a 403 status if the link does not belong to you.