API

Table of Contents

API
Pagination

LMS Collaborator - is an LMS system that works on the basis of RESTful API technology.

API

API (application programming interface) - a set of ready-made classes, procedures, functions, structures or constants provided by the Collaborator for interaction with other programs.
Used by programmers when writing all kinds of applications.

You can use our API to perform export/import of information to Collaborator, other commands, and create integrations with external programs.

The Collaborator RESTful API Reference Guide is available at https://your-domain-adress/api/v2/doc/, where you can find a list of possible ones and their descriptions.

Instead of a local address your-domain-adress you need to use the address of your server.

Pagination

The API uses pagination to split large datasets into smaller parts. Each GET request that returns a list of data has an object with two fields: data and pager. The pager field contains information about the pages:

{
  “data": [], // Array with data
  “pager": {
    “current": 1, // Current page
    “count": 3, // Number of pages
    “total": 22, // Total number of records
    “countPerPage": 10, // Number of records per page
  }
}

To navigate between pages, use the page parameter in the request, for example:

GET /api/v2/users/list?page=2&count=10