This document is generated by Aladia.

Aladia API

List All Categories

Developing

GET

/categories

This endpoint returns all categories.

Expected query parameters:

parentId: the term used to filter the categories and sub categories

showCourses: the term used to attach courses in categories

Returns:

All categories.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/categories?parentId=6672a58b25b551dfc47f4c17&showCourses=true&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

{
    "data": [
        {
            "id": "ece839cb38e659cbb3cbdef4",
            "parentId": "8e3328bdba0fa7a741ecde3e",
            "name": "Electronic Plastic Chicken",
            "description": "Principal",
            "image": {
                "fileId": "96bbeef8aa011d844f0bd054",
                "url": "https://fortunate-category.name",
                "metadata": {
                    "size": 1000,
                    "mimetype": "application/x-pilot",
                    "name": "test.png"
                }
            },
            "proposedUserId": "3859e895c787aa4822ca6048",
            "status": "active",
            "courses": [
                {
                    "id": "a9f4adca1f78cbe1370cab9e",
                    "owner": {
                        "id": "e5a4509f0c95fd9b991f65b4",
                        "firstName": "Troy",
                        "lastName": "Quitzon",
                        "name": "suscipit dicta magnam",
                        "followers": -93645159,
                        "hasActiveStory": true,
                        "online": false,
                        "email": "Shawn.Nienow@hotmail.com",
                        "picture": "https://loremflickr.com/640/480/sports"
                    },
                    "spaceId": "3eaa098bb8c8ecacedbbde14",
                    "chapters": [
                        "78f6dea8e278bfc2bdeccece",
                        "fbf07e026f61cadfae59be09",
                        "db990bd0de8c27cf717f44f5"
                    ],
                    "title": "v*M)LlI?,^",
                    "color": "sky blue",
                    "description": "The beautiful range of Apple Naturalé that has an exciting mix of natural ingredients. With the Goodness of 100% Natural Ingredients",
                    "thumbnail": {
                        "fileId": "3feea6c8b9d9ce80c6e27d2b",
                        "url": "https://victorious-neuropsychiatry.info",
                        "metadata": {
                            "size": 1000,
                            "mimetype": "chemical/x-csml",
                            "name": "test.png"
                        }
                    },
                    "trailer": {
                        "fileId": "ccc2cecee3d917645daadeac",
                        "url": "https://content-retrospectivity.net",
                        "metadata": {
                            "size": 1000,
                            "mimetype": "audio/melp1200",
                            "name": "test.png"
                        }
                    },
                    "trailerImage": null,
                    "duration": 99838,
                    "requirements": [
                        "+h\\KALtnNM",
                        ">w7h<z=BGZ"
                    ],
                    "objectives": [
                        "|+<VDrUZ!;"
                    ],
                    "earnings": 32505,
                    "numberOf": {
                        "observers": 54405,
                        "teachers": 84873,
                        "internalAttendants": 82430,
                        "externalAttendants": 24869,
                        "chapters": 76998,
                        "onDemandLectures": 30686,
                        "liveLectures": 48387
                    },
                    "type": "on-demand",
                    "visibility": "private",
                    "status": "ongoing",
                    "dates": {
                        "startDate": "2001-05-30T17:20:13.007Z",
                        "endDate": "2015-02-02T10:48:19.696Z"
                    },
                    "billing": {
                        "currency": "EUR",
                        "paymentModel": "recurring",
                        "totalPrice": 100,
                        "subscriptionFee": 5,
                        "remainingAmount": 10,
                        "installmentsAmount": 10,
                        "lastInstallmentAmount": 100,
                        "installmentNumber": 2,
                        "installments": [
                            "2004-07-18T01:18:53.474Z",
                            "2001-07-05T01:53:36.767Z",
                            "2071-07-09T05:33:05.512Z"
                        ],
                        "frequency": "month"
                    },
                    "seatCount": -46041900,
                    "languageId": "4cfecc5205e2ab7907db42e9",
                    "categories": [
                        {
                            "id": "a278f5c1bea769a3eb5a9614",
                            "parentId": "bcb8b307acaad6a59da0ff72",
                            "name": "Recycled Metal Chair",
                            "image": "https://loremflickr.com/640/480",
                            "proposedUserId": "ad3dee2faecec65cda341e05",
                            "status": "active",
                            "question": 84445,
                            "created

Request

Query Params

parentId

string

optional

The search query to filter categories.

Example:

6672a58b25b551dfc47f4c17

showCourses

string

optional

The query param to attach courses in categories.

Example:

true

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

data

array[object (category.rto) {8}]

required

string

optional

Unique Id

parentId

string

optional

Only for subcategory, is the ID of the category

name

string

optional

Name of Category or Subcategory

description

string | null

optional

category description

image

optional

Image of Category or Subcategory

proposedUserId

string

optional

Id of the user who proposed the category

status

string

optional

could be active or proposed

courses

array[object (course.rto) {45}]

optional

string

required

string

required

totalItems

integer

required

🟠422Parameter Error

Modified at 2025-04-12 09:46:05

Compare Latest Course

Create a Category