Get all conversation categories

GET /v2/conversation-categories/

API version

v2

Request method

GET

Operation ID

conversation-list-categories

---

Request

No request parameters.

Responses

Format

application/json

Description

Schema documentation

• Array[
• *object
  • categoryIdstring (uuid)

    required
  • namestring

    required
  • referenceTypearray of string (one of: unspecified, server, project, organisation, extensionInstance)

    required
    • Array[
    • *string (one of: unspecified, server, project, organisation, extensionInstance)
    ]

]

Example

[
  {
    "categoryId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "name": "string",
    "referenceType": [
      "unspecified"
    ]
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "categoryId": {
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "referenceType": {
        "items": {
          "enum": [
            "unspecified",
            "server",
            "project",
            "organisation",
            "extensionInstance"
          ],
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "categoryId",
      "name",
      "referenceType"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/conversation-categories

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.conversation.listCategories({});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Conversation\ListCategories\ListCategoriesRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListCategoriesRequest());
$response = $client->conversation()->listCategories($request);

var_dump($response->getBody();