Get a support conversation

GET/v2/conversations/{conversationId}/

API version

v2

Request method

GET

Operation ID

conversation-get-conversation

---

Request

• conversationIdstring (uuid)

  required

Responses

Format

application/json

Description

The metadata of the conversation. Does not contain messages send in the conversation. Use /v2/conversations/{conversationId}/messages to get the messages.

Schema documentation

• *

Example

Content-Type: application/json

null

JSON Schema

{
  "allOf": [
    {
      "properties": {
        "category": {
          "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"
        },
        "conversationId": {
          "format": "uuid",
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "lastMessageAt": {
          "format": "date-time",
          "type": "string"
        },
        "mainUser": {
          "properties": {
            "active": {
              "type": "boolean"
            },
            "avatarRefId": {
              "type": "string"
            },
            "clearName": {
              "type": "string"
            },
            "isEmployee": {
              "type": "boolean"
            },
            "userId": {
              "type": "string"
            }
          },
          "required": [
            "userId"
          ],
          "type": "object"
        },
        "notificationRoles": {
          "items": {
            "enum": [
              "customer_owner",
              "customer_accountant",
              "customer_member",
              "project_owner",
              "project_emailadmin",
              "project_external"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "relatedTo": {
          "oneOf": [
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "user"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "user"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "customer"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "customer"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "project"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "project"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "appinstallation"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "app"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "placementgroup"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "project"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "extensionInstance"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "extension"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "container"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "container"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            }
          ]
        },
        "relations": {
          "items": {
            "properties": {
              "aggregate": {
                "type": "string"
              },
              "domain": {
                "type": "string"
              },
              "id": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "aggregate",
              "domain"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "sharedWith": {
          "oneOf": [
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "user"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "user"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "customer"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "customer"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "project"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "project"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            {
              "properties": {
                "aggregate": {
                  "enum": [
                    "placementgroup"
                  ],
                  "type": "string"
                },
                "domain": {
                  "enum": [
                    "project"
                  ],
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            }
          ]
        },
        "shortId": {
          "type": "string"
        },
        "status": {
          "enum": [
            "open",
            "closed",
            "answered",
            "inProgress",
            "waiting"
          ],
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "visibility": {
          "enum": [
            "shared",
            "private"
          ],
          "type": "string"
        }
      },
      "required": [
        "conversationId",
        "shortId",
        "title",
        "createdAt",
        "status",
        "visibility",
        "mainUser"
      ],
      "type": "object"
    },
    {
      "properties": {
        "createdBy": {
          "properties": {
            "active": {
              "type": "boolean"
            },
            "avatarRefId": {
              "type": "string"
            },
            "clearName": {
              "type": "string"
            },
            "isEmployee": {
              "type": "boolean"
            },
            "userId": {
              "type": "string"
            }
          },
          "required": [
            "userId"
          ],
          "type": "object"
        },
        "lastMessage": {
          "properties": {
            "createdAt": {
              "format": "date-time",
              "type": "string"
            },
            "createdBy": {
              "properties": {
                "active": {
                  "type": "boolean"
                },
                "avatarRefId": {
                  "type": "string"
                },
                "clearName": {
                  "type": "string"
                },
                "isEmployee": {
                  "type": "boolean"
                },
                "userId": {
                  "type": "string"
                }
              },
              "required": [
                "userId"
              ],
              "type": "object"
            }
          },
          "required": [
            "createdAt"
          ],
          "type": "object"
        },
        "lastMessageBy": {
          "properties": {
            "active": {
              "type": "boolean"
            },
            "avatarRefId": {
              "type": "string"
            },
            "clearName": {
              "type": "string"
            },
            "isEmployee": {
              "type": "boolean"
            },
            "userId": {
              "type": "string"
            }
          },
          "required": [
            "userId"
          ],
          "type": "object"
        }
      },
      "type": "object"
    }
  ]
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/conversations/f0f86186-0a5a-45b2-aa33-502777496347

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.getConversation({
  "conversationId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetConversationRequest(
  conversationId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->conversation()->getConversation($request);

var_dump($response->getBody();