Skip to main content
GET
/
api
/
v1
/
articles
/
{id}
/
related
Get related articles
curl --request GET \
  --url https://www.suprsonic.com/api/v1/articles/{id}/related \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "slug": "<string>",
      "meta_description": "<string>",
      "hero_image_url": "<string>",
      "tags": [
        "<string>"
      ],
      "category": "opinion_piece",
      "publish_date": "2023-11-07T05:31:56Z",
      "tag_overlap_count": 123,
      "_links": {
        "self": "<string>",
        "account": "<string>"
      }
    }
  ]
}

Usage Notes

  • Related articles are determined by tag overlap with the source article
  • Only published articles with a publish date in the past are returned
  • Articles are sorted first by tag overlap count (descending), then by publish date (descending)
  • The source article is excluded from the results
  • If no related articles are found, an empty array is returned
  • This endpoint only returns article preview data (no content field) for performance reasons

Authorizations

Authorization
string
header
required

Admin API key for managing accounts and creating content

Path Parameters

id
string
required

The unique identifier (UUID or slug) of the article

Query Parameters

limit
integer
default:5

Number of related articles to return

Required range: 1 <= x <= 20

Response

Successfully retrieved related articles

success
boolean
Example:

true

data
object[]