> ## Documentation Index
> Fetch the complete documentation index at: https://kaneo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Mattermost integration

> Get the Mattermost integration for a project, or null when none is configured.



## OpenAPI

````yaml /openapi.json get /mattermost-integration/project/{projectId}
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /mattermost-integration/project/{projectId}:
    get:
      tags:
        - Mattermost
      summary: Get Mattermost integration
      description: >-
        Get the Mattermost integration for a project, or null when none is
        configured.
      operationId: getMattermostIntegration
      parameters:
        - schema:
            type: string
          required: true
          name: projectId
          in: path
      responses:
        '200':
          description: Mattermost integration details, or null
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MattermostIntegration'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: No access to the project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiKeyRateLimited'
components:
  schemas:
    MattermostIntegration:
      type:
        - object
        - 'null'
      properties:
        id:
          type: string
        projectId:
          type: string
        channelName:
          type:
            - string
            - 'null'
        webhookConfigured:
          type: boolean
        maskedWebhookUrl:
          type: string
          description: >-
            The webhook URL with its secret path segment masked, or an empty
            string when none is set.
        events:
          $ref: '#/components/schemas/IntegrationEvents'
        isActive:
          type:
            - boolean
            - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - projectId
        - channelName
        - webhookConfigured
        - maskedWebhookUrl
        - events
        - isActive
        - createdAt
        - updatedAt
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: Task not found
        code:
          type: string
          description: >-
            Stable UPPER_SNAKE_CASE code. Derived from the status unless a more
            specific code applies, such as VALIDATION_ERROR or
            MISSING_PERMISSION.
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                description: >-
                  Dotted path to the invalid input, prefixed with the request
                  part (body, query, params, header).
                example: body.title
              message:
                type: string
                example: Required
            required:
              - path
              - message
          description: Every validation issue, for VALIDATION_ERROR.
        missingPermissions:
          type: array
          items:
            type: string
          description: >-
            Permissions the caller lacks for this route, as resource:action, for
            MISSING_PERMISSION and API_KEY_SCOPE.
          example:
            - task:update
      required:
        - message
        - code
    IntegrationEvents:
      type: object
      properties:
        taskCreated:
          type: boolean
        taskStatusChanged:
          type: boolean
        taskPriorityChanged:
          type: boolean
        taskTitleChanged:
          type: boolean
        taskDescriptionChanged:
          type: boolean
        taskCommentCreated:
          type: boolean
      required:
        - taskCreated
        - taskStatusChanged
        - taskPriorityChanged
        - taskTitleChanged
        - taskDescriptionChanged
        - taskCommentCreated
  responses:
    ApiKeyRateLimited:
      description: >-
        The API key exceeded its rate limit or usage quota. Wait the number of
        seconds in Retry-After before retrying. The X-RateLimit headers are sent
        only when the rate limit was hit.
      headers:
        Retry-After:
          description: >-
            Seconds to wait before retrying. Omitted when an exhausted usage
            quota never refills.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests the API key may make per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time in seconds when the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.