HomeGuidesRecipesAPI Reference
Alation Help Center
Alation Help Center

Conversations v2 Overview

Description

Public API for working with conversations. Conversations and conversation posts can be created, read, replied to, modified, deleted, and searched. Conversation assignees can also be managed.

Changes from v1 to v2

Conversations API v2 has the following improvements:

  • We added endpoints for managing assignees for Conversations. Assignees can now be groups in addition to users.
  • We've added indicators for the number of replies and whether a conversation has been deleted.
  • You can now filter conversations by their creation date, the date of their last response, or whether the conversation has answers.

OpenAPI 3.0 Specification

The Conversations API v2 uses the OpenAPI 3.0 Specification (OAS). OAS is a broadly adopted industry standard for describing APIs. There are two ways to see the OpenAPI specification:

  1. Right here on the Developer Portal, where you can fill in parameter values and automatically construct an API call in dozens of different languages. Use the menu on the left to browse all our OpenAPI specifications.
  2. In the Swagger UI from within your Alation instance. In the Swagger UI, you can authenticate, fill in parameter values, and make API calls directly against your Alation instance from Swagger. To see the Swagger UI, go to:
https://{AlationInstanceURL}/openapi/conversations/