Artisyn API

List Categories

Developing

GET

http://127.0.0.1:3000/api/categories

Maintainer:Not configured

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1:3000/api/categories?search=Facilitator&page=1&limit=15&orderBy=id&orderDir=asc'

Response Example

{
    "data": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "icon": "string",
            "createdAt": "string",
            "updatedAt": "string"
        }
    ],
    "status": "string",
    "message": "string",
    "code": 0
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

string | null

optional

Filter categories by search

Example:

Facilitator

page

integer | null

optional

The page to load

Default:

Example:

limit

integer | null

optional

The number of results to return per page

Default:

Example:

orderBy

enum<string> | enum<null>

optional

Order the results by id or name

Allowed values:

idname

Example:

orderDir

enum<string> | enum<null>

optional

The direction to order the result

Allowed values:

descasc

Example:

asc

Responses

🟢200OK

application/json

Body

data

array [object {6}]

required

string

required

name

string

required

description

string

required

icon

string

required

createdAt

string

required

updatedAt

string

required

status

string

required

message

string

required

code

integer

required

Delete Category

Get Category