Comm-Links Overview
Returns paginated comm-links ordered by descending ID by default. Supports filtering by channel, category, series, title, content, and publication date. Results can be sorted by id, title, images_count, links_count, channel, category, series, and created_at. Use the include parameter to embed images or links.
Query parameters
Page number for pagination (starts at 1). Prefer using page[number] instead.
Page number for pagination (starts at 1).
Number of results per page. Maximum 200.
Available Comm-Link includes
Exact match on the Comm-Link CIG ID
Partial match on the Comm-Link title
Full-text search within English Comm-Link translations
Exact match on channel name (see GET /api/comm-links/filters for valid values)
Exact match on series name (see GET /api/comm-links/filters for valid values)
Exact match on category name (see GET /api/comm-links/filters for valid values)
Filter by publication year (YYYY) or exact date (YYYY-MM-DD)
Sort field. Prefix with "-" for descending. Supported: id, title, images_count, links_count, channel, category, series, created_at.
Response
Paginated list of Comm-Links
Example response
{
"data": [
{
"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"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"per_page": 30,
"to": 30,
"total": 150,
"path": "https://api.star-citizen.wiki/api/vehicles"
}
}Changes
Changed in 5 of the 50 revisions of this API.5421
- ○
added the optional property
data/items/translations/frto the response with the200statusresponse-optional-property-added
- ○
- ▲
the response's body type/format changed from
array/toobject/for status200response-body-type-changed
- ○
api operation id
2204c384d22cb7168f6dd5830328c4ddremoved and replaced withlistCommLinksapi-operation-id-removed
- ○
api tag
RSI-Websiteremovedapi-tag-removed
- ○
added the optional property
datato the response with the200statusresponse-optional-property-added
- ○
added the optional property
linksto the response with the200statusresponse-optional-property-added
- ○
added the optional property
metato the response with the200statusresponse-optional-property-added
- ▲
- ▲
removed the enum value
translationsfrom the propertyitems/of thequeryrequest parameterincluderequest-parameter-property-enum-value-removed
- ▲
- ▲
for the
queryrequest parameterfilter[id], the type/format was changed fromstring/tointeger/request-parameter-type-changed
- ▲
the
items/images/items/tags/items/response's property type/format changed fromstring/toobject/for status200response-property-type-changed
- ●
removed the optional property
items/links/items/api_urlfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
items/images/items/base_imageto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/comm_linksto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/duplicatesto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/nameto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/similarityto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/tags/items/images_countto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/tags/items/nameto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/images/items/tags/items/translated_nameto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/links/items/hrefto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/links/items/textto the response with the200statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response's body type/format changed from
object/toarray/for status200response-body-type-changed
- ●
removed the optional property
datafrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
linksfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
metafrom the response with the200statusresponse-optional-property-removed
- ○
api operation id
listCommLinksremoved and replaced with2204c384d22cb7168f6dd5830328c4ddapi-operation-id-removed
- ○
api tag
RSI-Websiteaddedapi-tag-added
- ○
added the enum value
translationsto the propertyitems/of thequeryrequest parameterincluderequest-parameter-property-enum-value-added
- ○
for the
queryrequest parameterfilter[id], the type/format was generalized frominteger/tostring/request-parameter-type-generalized
This revision also has 95 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲