# illuxiLMS Developper Hub

> All the documentation you need to interact with your illuxiLMS portal and integrate it with other systems.

## Docs

- [Columns](https://docs.illuxi.com/api-reference/columns.md): Specifies which columns to return.
- [Criterias](https://docs.illuxi.com/api-reference/criterias.md): Criterias can be used to filter the requested data.
- [Definition](https://docs.illuxi.com/api-reference/endpoint/availability_group/definition.md): Returns the definition of an [availability_group](/concepts/availability_group) object, including its properties and their types.
- [Edit availability_group](https://docs.illuxi.com/api-reference/endpoint/availability_group/edit.md): Edit an [availability_group](/concepts/availability_group) by ID
- [Get availability_group by ID](https://docs.illuxi.com/api-reference/endpoint/availability_group/get.md): Returns an [availability_group](/concepts/availability_group) based on a single ID
- [Get all availability_groups](https://docs.illuxi.com/api-reference/endpoint/availability_group/get_all.md): Returns a paginated list of [availability_groups](/concepts/availability_group) with optional filtering via [criterias](/api-reference/criterias).
- [Definition](https://docs.illuxi.com/api-reference/endpoint/bundle/definition.md): Returns the definition of the [bundle](/concepts/bundle) object, including its properties and their types.
- [Create group](https://docs.illuxi.com/api-reference/endpoint/grp/create.md): Create a new [grp](/concepts/grp)
- [Definition](https://docs.illuxi.com/api-reference/endpoint/grp/definition.md): Returns the definition of the [grp](/concepts/grp) object, including its properties and their types.
- [Delete group](https://docs.illuxi.com/api-reference/endpoint/grp/delete.md): Delete a [grp](/concepts/grp) by ID
- [Edit group](https://docs.illuxi.com/api-reference/endpoint/grp/edit.md): Edit a [grp](/concepts/grp) by ID
- [Get group by ID](https://docs.illuxi.com/api-reference/endpoint/grp/get.md): Returns a [grp](/concepts/grp) based on a single ID
- [Get all groups](https://docs.illuxi.com/api-reference/endpoint/grp/get_all.md): Returns a paginated list of [grps](/concepts/grp) with optional filtering via [criterias](/api-reference/criterias).
- [Get group by external ID](https://docs.illuxi.com/api-reference/endpoint/grp/get_by_external_id.md): Returns a [grp](/concepts/grp) by its external ID
- [Get group with children](https://docs.illuxi.com/api-reference/endpoint/grp/get_with_children.md): Returns a [grp](/concepts/grp) and all its child groups
- [Manage users in groups](https://docs.illuxi.com/api-reference/endpoint/grp/manage_users.md): Add, move, or remove users from [grps](/concepts/grp)
- [Definition](https://docs.illuxi.com/api-reference/endpoint/illuxi_availability/definition.md): Returns the definition of an [illuxi_availability](/concepts/illuxi_availability) object, including its properties and their types.
- [Edit illuxi_availability](https://docs.illuxi.com/api-reference/endpoint/illuxi_availability/edit.md): Edit an [illuxi_availability](/concepts/illuxi_availability) by ID
- [Get illuxi_availability by ID](https://docs.illuxi.com/api-reference/endpoint/illuxi_availability/get.md): Returns an [illuxi_availability](/concepts/illuxi_availability) based on a single ID
- [Get all illuxi_availabilities](https://docs.illuxi.com/api-reference/endpoint/illuxi_availability/get_all.md): Returns a paginated list of [illuxi_availabilities](/concepts/illuxi_availability) with optional filtering via [criterias](/api-reference/criterias).
- [Definition](https://docs.illuxi.com/api-reference/endpoint/product/definition.md): Returns the definition of the [product](/concepts/product) object, including its properties and their types. This endpoint is useful for understanding the structure of the product data and how to interact with it.
- [Get single product](https://docs.illuxi.com/api-reference/endpoint/product/get.md): Returns a [product](/concepts/product) based on a single ID
- [Get all products](https://docs.illuxi.com/api-reference/endpoint/product/get_all.md): Returns a paginated list of [products](/concepts/product), with optional filtering via [criterias](/api-reference/criterias).
- [Create product_access](https://docs.illuxi.com/api-reference/endpoint/product_access/create.md): Create a [product_access](/concepts/product_access) for a user
- [Definition](https://docs.illuxi.com/api-reference/endpoint/product_access/definition.md): Returns the definition of the [product_access](/concepts/product_access) object, including its properties and their types.
- [Delete product_access](https://docs.illuxi.com/api-reference/endpoint/product_access/delete.md): Delete a [product_access](/concepts/product_access) by ID
- [Edit product_access](https://docs.illuxi.com/api-reference/endpoint/product_access/edit.md): Edit a [product_access](/concepts/product_access) by ID
- [Get product_access by ID](https://docs.illuxi.com/api-reference/endpoint/product_access/get.md): Returns a [product_access](/concepts/product_access) record by ID
- [Get all product_access for bundle](https://docs.illuxi.com/api-reference/endpoint/product_access/get_all_for_bundle.md): Returns a paginated list of [product_access](/concepts/product_access) records linked to bundles with optional filtering via [criterias](/api-reference/criterias).
- [Get all product_access for product](https://docs.illuxi.com/api-reference/endpoint/product_access/get_all_for_product.md): Returns a paginated list of [product_access](/concepts/product_access) records linked to products with optional filtering via [criterias](/api-reference/criterias).
- [Definition](https://docs.illuxi.com/api-reference/endpoint/take/definition.md): Returns the definition of the [take](/concepts/take) object, including its properties and their types.
- [Generate certificate](https://docs.illuxi.com/api-reference/endpoint/take/generate_certificate.md): Generate a certificate for a completed [take](/concepts/take)
- [Get take by ID](https://docs.illuxi.com/api-reference/endpoint/take/get.md): Returns a [take](/concepts/take) record by ID
- [Get all takes](https://docs.illuxi.com/api-reference/endpoint/take/get_all.md): Returns a paginated list of [take](/concepts/take) records with optional filtering via [criterias](/api-reference/criterias).
- [Get all takes for user](https://docs.illuxi.com/api-reference/endpoint/take/get_all_for_user.md): Returns a paginated list of [take](/concepts/take) records for a specific user with optional filtering via [criterias](/api-reference/criterias).
- [Obtain token](https://docs.illuxi.com/api-reference/endpoint/token/index.md): Generate an access token to authenticate API requests.
- [Validate token](https://docs.illuxi.com/api-reference/endpoint/token/validate.md): Validate token to ensure it is still active
- [Activate user](https://docs.illuxi.com/api-reference/endpoint/user/activate.md): Activate a [user](/concepts/user) account
- [Create user](https://docs.illuxi.com/api-reference/endpoint/user/create.md): Create a new [user](/concepts/user)
- [Deactivate user](https://docs.illuxi.com/api-reference/endpoint/user/deactivate.md): Deactivate a [user](/concepts/user) account
- [Definition](https://docs.illuxi.com/api-reference/endpoint/user/definition.md): Returns the definition of the [user](/concepts/user) object, including its properties and their types.
- [Edit user](https://docs.illuxi.com/api-reference/endpoint/user/edit.md): Edit a [user](/concepts/user) by ID
- [Get user by ID](https://docs.illuxi.com/api-reference/endpoint/user/get.md): Returns a [user](/concepts/user) by ID
- [Get all users](https://docs.illuxi.com/api-reference/endpoint/user/get_all.md): Returns a paginated list of [users](/concepts/user) with optional filtering via [criterias](/api-reference/criterias).
- [Get user by organisation identifier](https://docs.illuxi.com/api-reference/endpoint/user/get_by_organisation_identifier.md): Returns a [user](/concepts/user) by their organisation identifier
- [Get recent users](https://docs.illuxi.com/api-reference/endpoint/user/get_recent.md): Returns the most recently created [users](/concepts/user)
- [Get recently updated users](https://docs.illuxi.com/api-reference/endpoint/user/get_recently_updated.md): Returns [users](/concepts/user) who were recently updated
- [Get all groups for user](https://docs.illuxi.com/api-reference/endpoint/user/grp.md): Returns a paginated list of [grps](/concepts/grp) for a specific [user](/concepts/user).
- [Create user_grp](https://docs.illuxi.com/api-reference/endpoint/user_grp/create.md): Create a [user_grp](/concepts/user_grp), hence adding a [user](/concepts/user) to a [group](/concepts/group)
- [Definition](https://docs.illuxi.com/api-reference/endpoint/user_grp/definition.md): Returns the definition of the [user_grp](/concepts/user_grp) object, including its properties and their types.
- [Delete user_grp](https://docs.illuxi.com/api-reference/endpoint/user_grp/delete.md): Remove a [user](/concepts/user) from a [group](/concepts/group) by [user_grp](/concepts/user_grp) ID
- [Edit user_grp](https://docs.illuxi.com/api-reference/endpoint/user_grp/edit.md): Edit a [user_grp](/concepts/user_grp) record by ID
- [Get user_grp by ID](https://docs.illuxi.com/api-reference/endpoint/user_grp/get.md): Returns a [user_grp](/concepts/user_grp) record by ID
- [Get all user_grps](https://docs.illuxi.com/api-reference/endpoint/user_grp/get_all.md): Returns a paginated list of [user_grp](/concepts/user_grp) records with optional filtering via [criterias](/api-reference/criterias).
- [Introduction](https://docs.illuxi.com/api-reference/introduction.md): How to get started quickly
- [Rate limits](https://docs.illuxi.com/api-reference/limits.md): Limits of the API usage.
- [Status Codes](https://docs.illuxi.com/api-reference/status-codes.md): All possible response status codes.
- [Webhooks](https://docs.illuxi.com/api-reference/webhooks.md): Webhooks allow third-party services to receive a POST request whenever a specific event is triggered.
- [Concepts](https://docs.illuxi.com/concepts.md): First, let’s go over the core concepts.
- [Cohort](https://docs.illuxi.com/concepts/availability_group.md): A cohort is a group of learners who follow the same course on the same schedule. They progress through the sessions together.
- [Bundle](https://docs.illuxi.com/concepts/bundle.md): A bundle represents a series of products that a user needs to complete. Bundles are often used as learning paths.
- [Capsule](https://docs.illuxi.com/concepts/capsule.md): A capsule is a unit of content within an asynchronous product.
- [Group](https://docs.illuxi.com/concepts/grp.md): A group is a container used to manage users collectively. It can include users, permissions that define what members are allowed to do on the platform, and enrollment access to products that can be assigned to all users in the group. This allows administrators to manage access and permissions more e…
- [Session](https://docs.illuxi.com/concepts/illuxi_availability.md): A session is a scheduled segment of a course. It has a set date and time, and learners attend it as part of completing the course.
- [Product](https://docs.illuxi.com/concepts/product.md): A product represents a training activity. It can take many forms, such as a course, a training session, a module, or a webinar, whether synchronous or asynchronous, online or in person. If your portal includes our e-commerce package, products can also be sold online.
- [Enrollment Access](https://docs.illuxi.com/concepts/product_access.md): An Enrollment Access grants a user permission to enroll in a course. It indicates that the user is authorized to begin the training but has not yet started it.
- [Enrollment Record](https://docs.illuxi.com/concepts/take.md): An Enrollment Record tracks a user’s progress in a specific product. It includes key information such as the start date, learning progress, completion status, and any results, such as scores or certificates. It represents the user’s actual participation in the product, not just access to it.
- [Membership](https://docs.illuxi.com/concepts/user_grp.md): A Group Membership is the record that links a user to a group. It indicates that the user is a member of the group and inherits the group’s permissions and enrollment access settings.
- [Introduction](https://docs.illuxi.com/index.md): 👋 Welcome to illuxiLMS Developer Hub! You will find here all the documentation available to integrate with your illuxiLMS portal.

## OpenAPI Specs

- [openapi](https://docs.illuxi.com/api-reference/openapi.yaml)