Company Topic List

An overview of the Company Topic List endpoint.

Endpoint Description

The Company Topic List endpoint provides the list of topics that are available to the specified company within their R1 Discover account.

HTTP Method

GET /api/v1/company-topic-list

Headers

• Content-Type: application/json — Indicates that the request body is formatted in JSON.

• Accept: application/json — Specifies that the response expected is in JSON format.

• Authorization: Bearer {token} — A valid authentication token must be provided to authorize the request.

URL Parameters

• N/A — This endpoint does not require any URL parameters as it fetches the list of available topics for all companies accessible based on the bearer token provided.

Data Dictionary

• topic_list: An array of topic objects available to the company.

  • company_id: The identifier for the company. (Type: Integer)

  • topic_id: A unique identifier for each topic. (Type: Integer)

  • name: The name of the topic. (Type: String)

  • video_url: The URL to access topic-related videos via an iFrame. (Type: String)

Request Example

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v1/company-topic-list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"

JavaScript

C# - Http

Response Examples

200: OK

{
  "error": 0,
  "message": "",
  "data": {
    "topic_list": [
      {
        "company_id": 1,
        "topics": [
          {
            "topic_id": 1,
            "name": "Stages of Change (SUD)",
            "video_url": "https://discover.r1learning.com/video-library/video/playTopic?topicID=1&rlt={REMOTE_LOGIN_TOKEN}&rlt_uid={USER_ID}"
          },
          {
            "topic_id": 2,
            "name": "Phases of Addiction",
            "video_url": "https://discover.r1learning.com/video-library/video/playTopic?topicID=2&rl={REMOTE_LOGIN_TOKEN}&rlt_uid={USER_ID}"
          }
        ]
      }
    ]
  }
}

401: Unauthorized

Notes

• Authorization Required: Access to this endpoint requires a valid bearer token that authorizes content retrieval for the specified company.

• Response Handling: The response includes a structured list of topics with URLs to access related content, ensuring easy integration and access for authorized users.