Retireve the video tutorial details
Contents
Mobile_API »Get Tutorials
Base URL
https://apimobile.callproof.com
Endpoint
/api/tutorials
Purpose
Retrieves tutorial videos grouped by category. Returns global tutorial categories (excluding the introductory category) plus company-specific videos, including YouTube thumbnail URLs when a video link is available.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
Successful Response (200)
Returns tutorial categories and their videos.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated user |
| company_id | integer | Identifier of the authenticated user’s company |
| data | array | List of tutorial categories with videos |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| category_id | integer | Unique identifier of the tutorial category |
| category_name | string | Display name of the category |
| category_key | string | Category key |
| video_details | array | Videos in this category |
data[].video_details[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the video |
| title | string | Video title |
| description | string | Video description |
| video_link | string | Video URL (for example, YouTube link) |
| position | integer | Display order of the video |
| thumbnail_default | string | Default YouTube thumbnail URL, when available |
| thumbnail_mqdefault | string | Medium-quality YouTube thumbnail URL, when available |
| thumbnail_sddefault | string | SD YouTube thumbnail URL, when available |
| thumbnail_maxresdefault | string | Max-resolution YouTube thumbnail URL, when available |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – tutorial videos could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while retrieving video details (for example, "Error while retriving the video details").
- 401 – Authentication failed or the access token is missing/expired.
