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 |

Operations 5

GET /public/api/plans/{id} Get #
POST /public/api/plans/{id}/assign Assign #
GET /public/api/plans?filter={filter} Get All #
GET /public/api/plans/count?where={where} Count #
GET /public/api/plans/export?type={type}&filter={filter} Export #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/yoobic-plans-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yoobic-plans-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: YOOBIC Public Plans API
  version: ''
  description: Welcome to the **YOOBIC Public API** documentation.
servers:
- url: https://<base_url>/
tags:
- name: Plans
  description: A plan is the main description of a course that's assigned to users.
paths:
  /public/api/plans/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan_id:
                    type: string
                  title:
                    type: string
                  description:
                    type: string
                  tenant:
                    type: string
                  created_date:
                    type: string
                  updated_date:
                    type: string
                example:
                  plan_id: 5c015012ad45490041a52f64
                  title: QA - Document
                  description: Course to test Documents Lessons
                  tenant: qa_boost
                  created_date: '2018-11-30T14:58:26.716Z'
                  updated_date: '2019-01-25T13:34:14.819Z'
              examples:
                response:
                  value:
                    plan_id: 5c015012ad45490041a52f64
                    title: QA - Document
                    description: Course to test Documents Lessons
                    tenant: qa_boost
                    created_date: '2018-11-30T14:58:26.716Z'
                    updated_date: '2019-01-25T13:34:14.819Z'
      summary: Get
      operationId: Get
      description: Get a plan for the given id.
      tags:
      - Plans
      parameters:
      - name: id
        in: path
        description: The id of the plan
        required: true
        example: 5c015012ad45490041a52f64
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      security:
      - oauth2: []
  /public/api/plans/{id}/assign:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                example:
                - 5e4514ac98ab7400553bf15f
                - 5e4514ac98ab7400553bf160
              examples:
                response:
                  value:
                  - 5e4514ac98ab7400553bf15f
                  - 5e4514ac98ab7400553bf160
      summary: Assign
      operationId: Assign
      description: Assign a plan to users. Response is an array of courses ids created for each assigned user.
      tags:
      - Plans
      parameters:
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      security:
      - oauth2: []
  /public/api/plans?filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  paging:
                    type: object
                    properties:
                      total:
                        type: number
                      skip:
                        type: number
                      limit:
                        type: number
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        plan_id:
                          type: string
                        title:
                          type: string
                        description:
                          type: string
                        tenant:
                          type: string
                        created_date:
                          type: string
                        updated_date:
                          type: string
                      required:
                      - plan_id
                      - title
                      - description
                      - tenant
                      - created_date
                      - updated_date
                example:
                  paging:
                    total: 2
                    skip: 0
                    limit: 1000
                  data:
                  - plan_id: 5c015012ad45490041a52f64
                    title: QA - Document
                    description: Course to test Documents Lessons
                    tenant: qa_boost
                    created_date: '2018-11-30T14:58:26.716Z'
                    updated_date: '2019-01-25T13:34:14.819Z'
                  - plan_id: 5c015558ad45490041a53473
                    title: QA - Video
                    description: Course to test Video Lessons
                    tenant: qa_boost
                    created_date: '2018-11-30T15:20:56.392Z'
                    updated_date: '2019-01-25T13:34:05.098Z'
              examples:
                response:
                  value:
                    paging:
                      total: 2
                      skip: 0
                      limit: 1000
                    data:
                    - plan_id: 5c015012ad45490041a52f64
                      title: QA - Document
                      description: Course to test Documents Lessons
                      tenant: qa_boost
                      created_date: '2018-11-30T14:58:26.716Z'
                      updated_date: '2019-01-25T13:34:14.819Z'
                    - plan_id: 5c015558ad45490041a53473
                      title: QA - Video
                      description: Course to test Video Lessons
                      tenant: qa_boost
                      created_date: '2018-11-30T15:20:56.392Z'
                      updated_date: '2019-01-25T13:34:05.098Z'
      summary: Get All
      operationId: Get All
      description: Get all the plans.
      tags:
      - Plans
      parameters:
      - name: filter
        in: query
        description: A valid JSON filter object
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/plans/count?where={where}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                example:
                  count: 10
              examples:
                response:
                  value:
                    count: 10
      summary: Count
      operationId: Count
      description: Count all the existing entities based on the where filter
      tags:
      - Plans
      parameters:
      - name: where
        in: query
        description: A valid JSON [Where filter](#section-api-requests-filter-where)
        required: false
        example: '{ "property": "value" }'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/plans/export?type={type}&filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  type:
                    type: string
                  priority:
                    type: number
                  nextRunAt:
                    type: string
                  _id:
                    type: string
                example:
                  name: Export file
                  type: normal
                  priority: 0
                  nextRunAt: '2018-09-11T15:56:05.387Z'
                  _id: 5b97e5954b99568b4b9101af
              examples:
                response:
                  value:
                    name: Export file
                    type: normal
                    priority: 0
                    nextRunAt: '2018-09-11T15:56:05.387Z'
                    _id: 5b97e5954b99568b4b9101af
      summary: Export
      operationId: Export
      description: 'Export all results as a file.

        This action is asynchronous and returns the id of a job. See `jobs` endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.'
      tags:
      - Plans
      parameters:
      - name: type
        in: path
        description: The type of file, either `csv` (default value) or `excel`
        required: true
        example: csv
        schema:
          type: string
      - name: filter
        in: query
        description: A valid JSON filter object (does not accept a `fields` filter)
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
components:
  schemas:
    Default_Header:
      type: object
      required:
      - Authorization
      properties:
        Authorization:
          type: string
          example: Bearer JWT
  requestBodies:
    Get_AllBody:
      content:
        application/json:
          schema:
            type: object
            properties:
              Authorization:
                $ref: '#/components/schemas/Default_Header'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /
          tokenUrl: /
          scopes: {}