Yoobic Plans API
A plan is the main description of a course that's assigned to users.### Fields| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`plan_id` | string | x | x | | Unique id of the plan ||`title` | string | | x | | The plan title ||`description` | string | | x | | Description of the plan ||`enable_journey` | boolean | | x | | Journey parameter activated or not ||`average_completed_lesson` | number | | x | | Average progression in the course ||`user_ids` | array | | | | User ids that are assigned to the plan ||`creator_id` | string | | | | ||`category_id` | string | | | | ||`competency_id` | string | | | | ||`created_date` | date | | x | | Creation date ||`updated_date` | date | | x | x | Last update date |
Yoobic Plans API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 5 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Plans API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
A plan is the main description of a course that's assigned to users. Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Default_Header (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.