Get categories

Returns a paginated list of categories. Optionally filter by category name or content scope. Results are sorted by name in ascending order by default.

get/knowledge-base/1/categories

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Query parameters

namestring

Filter categories by name.

scope'INTERNAL' | 'EXTERNAL'

Content scope of the node.

Example:INTERNAL

Filter categories by content scope.

pageinteger

Results page to retrieve (0..N).

sizeinteger

Number of records per page.

sortstring

Sort criteria in format 'field,direction'.

Response

Categories returned successfully

Example response

{
  "results": [
    {
      "name": "API Guides",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "visibility": "PUBLIC"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.