This document is generated by Aladia.

Aladia API

Search Categories

Developing

GET

/categories/search

This endpoint filters the categories using the category name

Expected query parameters:

name: the term used to search and filter the category using the category name as a query

parentId: the term used to search and filter the category using the parentId

showSubCategories: the term used to filter sub categories

Returns:

An array of Categories objects which partially match the query, inside a data property, as well as the pagination properties

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

{
  "data": [
    {
      "id": "ab0f2bf2ec8eeb8eefd4fcfd",
      "parentId": "fdebd0deb0ae8dea7ec82a94",
      "name": "Incredible Wooden Table",
      "description": "Corporate",
      "image": {
        "fileId": "a1af6cc83fda11f6f2fdde9d",
        "url": "http://hidden-comfortable.name",
        "metadata": {
          "size": 1000,
          "mimetype": "application/x-msmetafile",
          "name": "test.png"
        }
      },
      "proposedUserId": "ca6dcf81caf95a8eb44754a8",
      "status": "active",
      "courses": [
        {
          "id": "ba3baad5b8dc87afbfa82b49",
          "owner": {
            "id": "4b1a74abd4e99382ff218229",
            "firstName": "Jannie",
            "lastName": "Wilkinson",
            "name": "occaecati eaque exercitationem",
            "followers": 54631592,
            "hasActiveStory": false,
            "online": false,
            "email": "Katlynn_Wilkinson@yahoo.com",
            "picture": "https://loremflickr.com/640/480/sports"
          },
          "spaceId": "e40bbf2e0c51b3efef4aceda",
          "chapters": [
            "eacd72faa127a8822e7cfff5",
            "f85ddae34c07cab8ce606f1d",
            "2eb38bb2bd4abacb03c668fd"
          ],
          "title": ":]jH|2tpj]",
          "color": "indigo",
          "description": "The Football Is Good For Training And Recreational Purposes",
          "thumbnail": null,
          "trailer": null,
          "trailerImage": {
            "fileId": "e9a4de0daa0fe3cd0e7f07ed",
            "url": "http://acceptable-detainee.com",
            "metadata": {
              "size": 1000,
              "mimetype": "application/macwriteii",
              "name": "test.png"
            }
          },
          "duration": 45379,
          "requirements": [
            "p'e6G/atdj"
          ],
          "objectives": [
            "Fp|Q\\_Ood=",
            "B=UDssmQaL"
          ],
          "earnings": 24485,
          "numberOf": {
            "observers": 19854,
            "teachers": 85230,
            "internalAttendants": 8621,
            "externalAttendants": 42199,
            "chapters": 2510,
            "onDemandLectures": 27103,
            "liveLectures": 81385
          },
          "type": "on-demand",
          "visibility": "private",
          "status": "ongoing",
          "dates": {
            "startDate": "2097-06-30T05:13:05.958Z",
            "endDate": "2004-09-10T23:52:29.557Z"
          },
          "billing": null,
          "seatCount": 8186130,
          "languageId": "ccfb8a71d987b47ae29b1753",
          "categories": [
            {
              "id": "80bcf5a82bb2b959b6aac4fb",
              "parentId": "9217be814be4e9f8ed3a5ceb",
              "name": "Electronic Bronze Bike",
              "image": "https://loremflickr.com/640/480",
              "proposedUserId": "9c0fcb3f8d4087b4a5ecbcdb",
              "status": "active",
              "question": 14980,
              "createdAt": "2024-10-20T21:24:04.497Z",
              "updatedAt": "2024-10-20T17:38:18.640Z"
            }
          ],
          "subCategories": [
            {
              "id": "8ea3d3f5aa2bdfe0ebae28be",
              "parentId": "af9b9bff3737c194efedc4a1",
              "name": "Rustic Wooden Car",
              "image": "https://loremflickr.com/640/480",
              "proposedUserId": "0e16a434ed5a6f90dfde0095",
              "status": "active",
              "question": 99449,
              "createdAt": "2024-10-21T03:29:45.497Z",
              "updatedAt": "2024-10-20T20:52:32.010Z"
            }
          ],
          "review": {
            "ratings": [
              {
                "star": 10014,
                "count": 28080,
                "percentage": 13136
              }
            ],
            "totalReviews": 15,
            "globalRating": -70112248
          },
          "role": "course-teacher",
          "suspend": true,
          "createdBy": "0f20ac1af412fa67ecf2d2c7",
          "updatedBy": "ca9e9dcd353dadb7caf31abc",
          "roomId": "c58fcd5b65ecc057e9e7ded8",
          "calendarId": "a3ac3c7ca5df88dabb56a09a",
          "productId": "c3fdea4701567f96c01d5e13",
          "createdAt": "2049-07-10T16:44:36.736Z",
          "updatedAt": "2023-10-25T16:02:27.799Z",
          "folderId": "fa1c61edeae4cd96136917fd",
          "buyers": [
            73080335
          ],
          "purchased": null,
          "members": null,
          "version": null
        },
        {
          "id": "69afeefa29077bc3ccf7cf3e",
          "owner": {
            "id": "fac408f5c0dbc1eb43cc6a9a",
            "firstName": "Lelia",
            "lastName": "Thiel",
            "name": "laboriosam optio voluptas",
            "followers": -74035043,
            "hasActiveStory": true,
            "online": false,
            "email": "Zoe88@yahoo.com",
            "picture": "https://loremflickr.com/640/480/nightlife"
          },
          "spaceId": "3dfcf4ed71359aecf1dc9b6a",
          "chapters": [
            "bfde7c40f2f77e9e65c7faba",
            "898de03dcdbf66e9eac6fd8f",
            "c07adddba1bed3b30f67defe"
          ],
          "title": "nT!vR3Kp!#",
          "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": "36b1578d3471c39cd09daab4",
            "url": "https://metallic-boar.com",
            "metadata": {
              "size": 1000,
              "mimetype": "chemical/x-pdb",
              "name": "test.png"
            }
          },
          "trailer": null,
          "trailerImage": {
            "fileId": "ccdfcc48cd8bb061fb645d5a",
            "url": "https://treasured-tract.biz",
            "metadata": {
              "size": 1000,
              "mimetype": "application/vnd.3gpp.mcptt-mbms-usage-info+xml",
              "name": "test.png"
            }
          },
          "duration": 73207,
          "requirements": [
            "8tJE\\UgPl3"
          ],
          "objectives": [
            "$q7%(K<^*V",
            "VD%{Rkj^vl",
            "m</FF*V4!Y"
          ],
          "earnings": 12639,
          "numberOf": {
            "observers": 55141,
            "teachers": 60775,
            "internalAttendants": 9193,
            "externalAttendants": 70778,
            "chapters": 31966,
            "onDemandLectures": 62786,
            "liveLectures": 90312
          },
          "type": "on-demand",
          "visibility": "private",
          "status": "ongoing",
          "dates": {
            "startDate": "2019-12-04T08:04:40.771Z",
            "endDate": "2088-04-27T23:46:43.672Z"
          },
          "billing": {
            "currency": "EUR",
            "paymentModel": "recurring",
            "totalPrice": 100,
            "subscriptionFee": 5,
            "remainingAmount": 10,
            "installmentsAmount": 10,
            "lastInstallmentAmount": 100,
            "installmentNumber": 2,
            "installments": [
              "2074-06-01T06:11:12.594Z",
              "2036-02-05T22:42:54.076Z",
              "2090-10-25T10:58:38.015Z"
            ],
            "frequency": "month"
          },
          "seatCount": null,
          "languageId": "bce78aeee1bd8e1006acaea8",
          "categories": [
            {
              "id": "ecf92e752ea7b0210e2a16f7",
              "parentId": "a8debd01b2ed34bc2bb6b8de",
              "name": "Awesome Concrete Keyboard",
              "image": "https://loremflickr.com/640/480",
              "proposedUserId": "a79e9b8aa5b3dec316dcfadd",
              "status": "active",
              "question": 45374,
              "createdAt": "2024-10-20T16:22:45.688Z",
              "updatedAt": "2024-10-20T15:15:10.643Z"
            }
          ],
          "subCategories": [
            {
              "id": "ded1fab2d8cfb892ea4da8cf",
              "parentId": "ae5d2dceadbadedae2afa7ee",
              "name": "Unbranded Plastic Bike",
              "image": "https://loremflickr.com/640/480",
              "proposedUserId": "d2afe4dce6adfe6bbccd5cc4",
              "status": "active",
              "question": 83751,
              "createdAt": "2024-10-21T04:16:58.795Z",
              "updatedAt": "2024-10-21T05:33:22.093Z"
            }
          ],
          "review": {
            "ratings": [
              {
                "star": 80764,
                "count": 39508,
                "percentage": 9357
              }
            ],
            "totalReviews": 15,
            "globalRating": -15812076
          },
          "role": "course-teacher",
          "suspend": true,
          "createdBy": "ecaca8baff1221afa9fcb0ba",
          "updatedBy": "29b05ddc2e8a6afb9ae8ceef",
          "roomId": "cdf57a7c7ad540dacbdada2f",
          "calendarId": "e806e36fdb28ff4ebc95ffd9",
          "productId": "e7fd7cb7e8cb38e8b5fdd31a",
          "createdAt": "2040-09-11T03:33:00.639Z",
          "updatedAt": "2092-04-26T20:29:47.885Z",
          "folderId": "b3637dbb71d2ab159857e176",
          "buyers": [
            45808116
          ],
          "purchased": null,
          "members": {
            "teachers": [
              {
                "id": "5febbdf97b87a52e9db61a6e",
                "fullName": "April Beier",
                "picture": "https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/672.jpg",
                "role": "teacher",
                "online": true,
                "lastActivity": "2053-05-06T01:14:57.858Z",
                "email": "Marley_Dibbert37@hotmail.com",
                "invited": true,
                "invitedAt": "1997-10-09T14:14:38.506Z"
              }
            ],
            "attendants": [
              {
                "id": "0f839cacf66eef1bcc3eab2f",
                "fullName": "Maxine Borer",
                "picture": "https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/4.jpg",
                "role": "teacher",
                "online": true,
                "lastActivity": "1995-05-06T21:13:28.164Z",
                "email": "Kayden.Rolfson3@gmail.com",
                "invited": true,
                "invitedAt": "2089-09-18T14:07:02.815Z"
              },
              {
                "id": "d4a6f7e2544f8fbc9ff5dfda",
                "fullName": "Nicholas Rohan",
                "picture": "https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/919.jpg",
                "role": "teacher",
                "online": true,
                "lastActivity": "2015-05-05T00:15:33.951Z",
                "email": "Mariela1@hotmail.com",
                "invited": true,
                "invitedAt": "2076-02-22T06:13:57.157Z"
              },
              {
                "id": "8246ecbaeb6fafdfdf4a3ab7",
                "fullName": "Owen Hand",
                "picture": "https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/417.jpg",
                "role": "teacher",
                "online": true,
                "lastActivity": "2024-01-14T02:03:51.264Z",
                "email": "Steve.Bartell@yahoo.com",
                "invited": true,
                "invitedAt": "2032-05-04T06:07:52.810Z"
              }
            ]
          },
          "version": {
            "id": "ca582cf3bd16382c8963e62f",
            "profile": {
              "id": "b82223c8cd0cbe310bc1235f",
              "firstName": "Rhett",
              "lastName": "Johnston",
              "name": "quaerat repellat asperiores",
              "followers": -39617627,
              "hasActiveStory": true,
              "online": false,
              "email": "Timmothy58@hotmail.com",
              "picture": "https://loremflickr.com/640/480/abstract"
            },
            "title": "Version_2024_09_19_12:32:06",
            "version": "2099-08-18T02:31:49.241Z",
            "description": "uniform",
            "status": "draft",
            "course": {
              "id": "b0b6c7469d70a7f001fd4da2",
              "revision": false
            },
            "chapters": [
              {
                "id": "482de90c8e08330194ead6ea",
                "revision": false,
                "lectures": [
                  {
                    "id": "b27e2bb8c11e20e37de4b9e6",
                    "revision": false
                  },
                  {
                    "id": "4eafd5c8c7e5d9c3d8fe30ce",
                    "revision": true
                  },
                  {
                    "id": "acbacf0d349dab2b5fb39bfe",
                    "revision": true
                  }
                ]
              },
              {
                "id": "2a6f1ff13941e77bf241dd2e",
                "revision": true,
                "lectures": [
                  {
                    "id": "2f66f2a08c0d372a37c4deab",
                    "revision": false
                  }
                ]
              }
            ],
            "restored": true,
            "original": "c2b1aa61dccbfd5ebfced211",
            "createdAt": "2036-09-05T12:10:23.262Z",
            "updatedAt": "2096-02-28T18:03:35.266Z"
          }
        }
      ]
    }
  ],
  "next": "dolore mollit",
  "prev": "ex ad aliqua",
  "totalItems": 34548759
}

Request

Query Params

name

string

optional

The search query string.

Example:

website

parentId

string

optional

The search query to filter categories.

Example:

6672a58b25b551dfc47f4c17

showSubCategories

string

optional

The query param to filter sub 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

🟠401Unauthorized

Modified at 2025-04-08 15:35:26

Retrieve a Category

Delete a Category