List of Categories

Developing

GET

/api/{organization}/categories

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/api/y91o1vbv1NJlkkvTnkuSVKPCuaAb0dA0/categories?term=&project_limit=&page=1&per_page=10&order_by=name&order_type=asc&permissions[]=view&permissions[]=edit&permissions[]=publish'

Response Example

{
    "data": [
        {
            "id": 0,
            "name": "string",
            "description": "string",
            "icon": "string",
            "color": "string",
            "created_by": 0,
            "general_access": "string",
            "general_permission": "string",
            "system_default": true,
            "projects": [
                {
                    "project_id": 0,
                    "name": "string",
                    "description": "string",
                    "image_url": "string",
                    "image_path": "string",
                    "avatar_url": "string",
                    "color_hex": "string",
                    "general_access": "string",
                    "sort": 0,
                    "created_by": 0,
                    "updated_by": 0,
                    "created_at": "string",
                    "updated_at": "string",
                    "archived_at": null,
                    "folder_count": 0,
                    "subitems_count": 0,
                    "documents_count": 0,
                    "owner": {
                        "id": 0,
                        "goteam_id": 0,
                        "user_id": 0,
                        "name": "string",
                        "fname": "string",
                        "mname": "string",
                        "lname": "string",
                        "first_name": "string",
                        "last_name": "string",
                        "initials": "string",
                        "email": "string",
                        "avatar": "string",
                        "status": "string",
                        "source": "string",
                        "superadmin": true,
                        "org_admin": true,
                        "role": "string",
                        "mfa": 0,
                        "created_at": "string",
                        "goteam_internal": true,
                        "two_factor_confirmed_at": null,
                        "goteam_position": "string"
                    },
                    "users": [
                        "string"
                    ],
                    "teams": [
                        "string"
                    ],
                    "category": {
                        "id": 0,
                        "name": "string",
                        "description": "string",
                        "icon": "string",
                        "color": "string",
                        "created_by": 0,
                        "general_access": "string",
                        "general_permission": "string",
                        "system_default": true,
                        "projects_count": null,
                        "folders_count": null,
                        "documents_count": null,
                        "created_at": "string",
                        "updated_at": "string",
                        "url": "string",
                        "can_edit": true,
                        "can_delete": true,
                        "setting_up": 0
                    },
                    "url": "string",
                    "can_edit": true
                }
            ],
            "projects_count": 0,
            "folders_count": 0,
            "documents_count": 0,
            "created_at": "string",
            "updated_at": "string",
            "url": "string",
            "can_edit": true,
            "can_delete": true,
            "setting_up": 0
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": null,
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "links": [
            {
                "url": "string",
                "label": "string",
                "active": true
            }
        ],
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

organization

string

required

The organization identifier from Source Wiki

Example:

y91o1vbv1NJlkkvTnkuSVKPCuaAb0dA0

Query Params

term

string

optional

A keyword or phrase used to filter results by matching relevant fields, such as names or descriptions.

project_limit

integer

optional

Limit the number of projects included in the response per category. Default is 15.

page

integer

optional

The page number of the paginated results to retrieve. Used in combination with 'per_page' to navigate through result sets.

Example:

per_page

integer

optional

The number of results to return per page. Used for pagination in conjunction with the page parameter.

Example:

order_by

string

optional

The name of the column by which to sort the results. Must correspond to a valid sortable field.

Example:

name

order_type

string

optional

The sort direction for the results. Accepts 'asc' for ascending order or 'desc' for descending order.

Example:

asc

permissions[]

array[string]

optional

Filters the results based on the current user's permissions. Valid values are view (resources the user can view), edit (resources the user can edit), and publish (resources the user can publish).

Example:

["view","edit","publish"]

Responses

🟢200OK

application/json

Body

data

array [object {19}]

required

integer

required

name

string

required

description

string | null

required

icon

string

required

color

string

required

created_by

integer | null

required

general_access

string

required

general_permission

string

required

system_default

boolean

required

projects

array [object {23}]

required

projects_count

integer

required

folders_count

integer

required

documents_count

integer

required

created_at

string

required

updated_at

string

required

url

string

required

can_edit

boolean

required

can_delete

boolean

required

setting_up

integer

required

links

object

required

first

string

required

last

string

required

null

required

string

required