Skip to content
Colleqtive Developer
Get started
API Reference
Categories

List Categories

GET/api/v2/public/categories

Product categories for the organisation. Use parent_category_code to walk the hierarchy one level at a time. Returns the category_code values the product endpoints expect.

Query ParametersExpand Collapse
module_id: optional number

Restricts the result to categories enabled for this module.

formatint64
page_size: optional number

Number of categories per page. Defaults to 10.

formatint32
page_start: optional number

Page number, starting at 1. Defaults to 1.

formatint32
parent_category_code: optional string

Returns only the direct children of this category code.

search_text: optional string

Case-insensitive search in the category name.

ReturnsExpand Collapse
page_size: number

Maximum number of items returned per page.

formatint32
page_start: number

Current page number (1-based).

formatint32
total_count: number

Total number of records matching the query across all pages.

formatint64
list: optional array of object { edit_min_max_percentage, is_adjust_min_max, category_code, 5 more }

Collection of items for the current page.

edit_min_max_percentage: number
formatint32
is_adjust_min_max: boolean
category_code: optional string
category_name: optional string
child_categories: optional array of unknown
parent_category_code: optional string
parent_category_name: optional string
top_parent_category_code: optional string
list_body: optional map[unknown]

Additional body-level metadata for the list.

list_filters: optional map[array of string]

Active filter criteria applied to the result set, keyed by field name.

next_page: optional number

Next page number, or null when on the last page.

formatint32
previous_page: optional number

Previous page number, or null when on the first page.

formatint64
project_last_modified_date: optional string

Last modified date/time of the project.

scroll_id: optional string

Opaque scroll identifier for deep-pagination scenarios.

server_time: optional string

Server UTC date/time when the response was generated.

sort_column: optional string

Column name the results are sorted by.

sort_order: optional string

Sort direction (asc or desc).

task_last_modified_date: optional string

Last modified date/time of the task.

List Categories

curl https://api.colleqtive.net/api/v2/public/categories \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "edit_min_max_percentage": 0,
      "is_adjust_min_max": true,
      "category_code": "category_code",
      "category_name": "category_name",
      "child_categories": [
        {}
      ],
      "parent_category_code": "parent_category_code",
      "parent_category_name": "parent_category_name",
      "top_parent_category_code": "top_parent_category_code"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}
{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}
{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}
Returns Examples
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "edit_min_max_percentage": 0,
      "is_adjust_min_max": true,
      "category_code": "category_code",
      "category_name": "category_name",
      "child_categories": [
        {}
      ],
      "parent_category_code": "parent_category_code",
      "parent_category_name": "parent_category_name",
      "top_parent_category_code": "top_parent_category_code"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}
{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}
{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}