Topic
The Topic API allows people to retrieve info about topics.
GET
/topics
DESCRIPTION
Returns all topics, filtered by the 'topic' GET filter.
PARAMETERS
| Parameter | Type | Required | Description | Values | Default |
|---|---|---|---|---|---|
| topic | GET | Optional | The topic name to filter by. | Any text | NULL |
RESPONSE
Type: application/json
A JSON object that complies with the JSON API standard (www.jsonapi.org).
| Status Code | Meaning |
|---|---|
| 200 | Successfully queried topics. |
| 401 | Invalid API key provided. |
| 405 | Invalid request HTTP method. |
Example Success Response
GET
/topics/:topic-id
DESCRIPTION
Returns info about the Topic entity associated with the given ID.
PARAMETERS
| Parameter | Type | Required | Description | Values | Default |
|---|---|---|---|---|---|
| topic-id | URL_SLUG | Required | The ID of the Topic entity to retrieve. | Any positive integer | NULL |
RESPONSE
Type: application/json
A JSON object that complies with the JSON API standard (www.jsonapi.org).
| Status Code | Meaning |
|---|---|
| 200 | Successfully queried specified topic. |
| 401 | Invalid API key provided. |
| 404 | No topic was found for the provided ID. |
| 405 | Invalid request HTTP method. |