Sign in
Comm-Links
RSI-Website

Comm-Link Search (Deprecated)

Deprecated. Use GET /api/comm-links?filter[title]={value} for title search. This endpoint will be removed in a future version.

post/api/comm-links/search

Query parameters

localestring

Locale code for translated fields (e.g. en, de, zh).

includestring[]

Available Comm-Link includes

filter[channel]string
Example:Engineering

Exact match on channel name (see GET /api/comm-links/filters for valid values)

filter[series]string
Example:Around the Verse

Exact match on series name (see GET /api/comm-links/filters for valid values)

filter[category]string
Example:General

Exact match on category name (see GET /api/comm-links/filters for valid values)

Request body

keywordstring

Search term for partial title match (min 3 characters)

querystring

Search term for partial title match or numeric CIG ID (min 1 character)

Example request

{
  "keyword": "Banu Merchantman",
  "query": "This Week in Star Citizen"
}

Response

A singular Comm-Link

idinteger

CIG identifier for the Comm-Link

titlestring

Title of the Comm-Link

rsi_urlstring uri

Link to the Comm-Link on the RSI website.

api_urlstring uri

API URL for this Comm-Link resource.

api_public_urlstring uri

Public web URL for this Comm-Link on the API portal.

channelstring

Publishing channel, e.g. Engineering, Transmission.

categorystring

Content category, e.g. General, Community, Lore, Development.

seriesstring

Series the Comm-Link belongs to, e.g. Around the Verse, 10 For the Chairman.

images_countinteger

Total number of images associated with this Comm-Link.

links_countinteger

Total number of external links in the Comm-Link content.

comment_countinteger

Number of comments on the original RSI post.

created_atstring date-time

ISO 8601 timestamp of when the Comm-Link was published.

created_at_humanstring

Human-readable relative time since publication.

Example response

{
  "id": 12663,
  "title": "This Week in Star Citizen",
  "channel": "Engineering",
  "category": "General",
  "series": "Around the Verse",
  "images": [
    {
      "name": "Starshipbridge.jpg",
      "rsi_url": "/media/bluo97w6u7n1ur/source/Starshipbridge.jpg",
      "size": 1504015,
      "mime_type": "image/jpeg"
    }
  ],
  "images_count": 5,
  "links": [
    {
      "href": "http://robertsspaceindustries.com/forums/",
      "text": "forums"
    }
  ],
  "links_count": 3,
  "comment_count": 42,
  "created_at_human": "1 hour ago"
}

Changes