In order to interact with this API you will need to read Getting Started with the API.

List of collected links for a publication

Retrieve details for a specific link

Create a link

Update a link

Delete a link

List of collected links for a publication

You can fetch all collected links for a publication that do not belong to an issue.

GET /publications/{publication_id}/links

Retrieve details for a specific link

This API is located at:

GET /publications/{publication_id}/links/{link_id}

There is one required parameter and it should be passed as part of the URL.

  • link_id - This id can be find by retrieving the list of collected links.

Create a link

POST /publications/{publication_id}/links

Here are the parameters that can be passed with creating a link. These should be passed on the query string:

  • url - Required. The URL for the collected link.
  • title - Optional. The title of the collected link.
  • description - Optional. A description for the collected link.
  • image - Optional. A URL for an image to upload.
  • category - Optional. The category "code" for the collected link.

Update a link

You can update a link as long as it doesn't belong to a published issue.

PUT /publications/{publication_id}/links/{id}

There is one required parameter and it should be passed as part of the URL.

  • id - Required. This id can be find by retrieving the list of collected links.

There are some optional parameters which can be supplied to update the link or move it to a draft issue. These should be passed on the query string:

  • url - The URL for the collected link.

  • title - The title of the collected link.

  • description - A description for the collected link.

  • category - The category "code" for the collected link.

  • issue_id - Can be set to an id that belongs to a draft issue, and it will move the link from the collected items to that issue. Set to blank to move back to collected items.

Note: once you move a link to a draft issue, it will no longer show up in the list of collected items.

Delete a link

DELETE /publications/{publication_id}/links/{id}

There is one required parameter and it should be passed as part of the URL.

  • id - This id can be find by retrieving the list of collected links.