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

# List dedicated integrations

> List the dedicated integrations owned by one channel.

## Restrictions

| Aspect | Value |
| - | - |
| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |
| Permissions | **Channels Read**, **Channels Manage**, or **Integrations Read** (`on-call`) |

## Usage

* These APIs manage channel-owned dedicated integrations; use `/integration/*` for public integrations.
* The App Key's `api_scopes` must allow the operation; permissions follow the user who owns the key.
* Private channels also require the account owner, an Admin, the channel creator, or membership in its owning or managing teams; public channels still require the API permission above.
* `channel_id` is required; `p` defaults to `1` and `limit` defaults to `100`, with a maximum of `100`.
* `plugin_type` and `status` each accept one value.
* The complete `integration_key` is returned; saved secret values in `settings` are returned as `******`. The integration key authenticates alert ingestion and is separate from the management App Key.


## OpenAPI

````yaml /api-reference/on-call.openapi.en.json post /channel/integration/list
openapi: 3.1.0
info:
  title: Flashduty Open API
  description: >-
    Public HTTP API for the Flashduty incident management platform — incidents,
    notification templates, channels, schedules, monitors, RUM, and platform
    administration. Every operation is authenticated with an `app_key` query
    parameter created in the Flashduty console under My → APP Key (or sent in
    the `Fd-App-Key` header). Responses follow a uniform envelope: `{
    request_id, data }` on success, `{ request_id, error }` on failure.
  version: 1.0.0
servers:
  - url: https://api.flashcat.cloud
    description: Flashduty Open API
security:
  - AppKeyAuth: []
tags:
  - name: On-call/Incidents
    description: ''
  - name: On-call/Channels
    description: ''
  - name: On-call/Alerts
    description: >-
      Search, inspect, and act on alerts. Manage card views and alert processing
      pipelines.
  - name: On-call/Integrations
    description: ''
  - name: On-call/IM integrations
    description: IM integration queries, such as which integrations have war room enabled.
  - name: On-call/Schedules
    description: ''
  - name: On-call/Licenses
    description: ''
  - name: On-call/Calendars
    description: ''
  - name: On-call/Notification templates
    description: ''
  - name: On-call/Alert enrichment
    description: Custom fields, enrichment rules, and data mapping (schema, data, API).
  - name: On-call/Analytics
    description: ''
  - name: On-call/Status pages
    description: ''
  - name: On-call/Changes
    description: ''
  - name: On-call/Dedicated integrations
    description: Manage alert integrations owned by individual channels.
paths:
  /channel/integration/list:
    post:
      tags:
        - On-call/Dedicated integrations
      summary: List dedicated integrations
      description: List the dedicated integrations owned by one channel.
      operationId: channel-integration-read-list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelIntegrationListRequest'
            example:
              channel_id: 20001
              p: 1
              limit: 20
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ChannelIntegrationListResponse'
              example:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                data:
                  p: 1
                  limit: 20
                  total: 1
                  items:
                    - integration_id: 10001
                      channel_id: 20001
                      integration_key: 0123456789abcdef0123456789abcdef100
                      exclusive_data_source_id: 0
                      plugin_id: 9
                      plugin_type: standard.alert
                      plugin_type_name: Standard alert
                      category: event.alert
                      name: Payments alerts
                      description: Alerts for the payments channel
                      status: enabled
                      created_at: 1767225600
                      updated_at: 1767225600
                      last_time: 0
                      last_source_time: 0
                      settings: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    ChannelIntegrationListRequest:
      type: object
      description: Filters and pagination for one channel's dedicated integrations.
      required:
        - channel_id
      properties:
        channel_id:
          type: integer
          format: int64
          minimum: 1
          example: 20001
          description: Channel ID to list dedicated integrations for.
        p:
          type: integer
          minimum: 1
          default: 1
          description: Page number, starting at 1.
        limit:
          type: integer
          minimum: 1
          maximum: 100
          default: 100
          description: Number of items per page, at most 100.
        name:
          type: string
          maxLength: 49
          description: Filter by integration name.
        plugin_type:
          type: string
          description: Filter by one integration type.
        status:
          type: string
          enum:
            - enabled
            - disabled
          description: >-
            Filter by `enabled` integrations that accept alerts or `disabled`
            integrations that pause ingestion.
    SuccessEnvelope:
      type: object
      description: >-
        Success response envelope. On every 2xx response, `request_id`
        identifies the call (also mirrored in the `Flashcat-Request-Id` header)
        and `data` holds the endpoint-specific payload. Failure responses use a
        different shape — see `ErrorResponse`.
      properties:
        request_id:
          type: string
          description: >-
            Unique ID for this request. Mirrored in the Flashcat-Request-Id
            response header. Include it when reporting issues.
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        data:
          description: >-
            Operation-specific payload, documented in each operation's 200
            response. Operations without a payload return `{}` or omit `data`
            entirely.
      required:
        - request_id
    ChannelIntegrationListResponse:
      type: object
      description: One page of dedicated integrations.
      required:
        - p
        - limit
        - total
        - items
      properties:
        p:
          type: integer
          description: Returned page number.
        limit:
          type: integer
          description: Returned page size.
        total:
          type: integer
          description: Total number of matching dedicated integrations.
        items:
          type: array
          items:
            $ref: '#/components/schemas/ChannelIntegrationItem'
          description: Dedicated integrations on this page.
    ChannelIntegrationItem:
      type: object
      description: >-
        A channel-owned dedicated integration, with its complete key and masked
        settings.
      required:
        - integration_id
        - channel_id
        - integration_key
        - exclusive_data_source_id
        - plugin_id
        - plugin_type
        - plugin_type_name
        - category
        - name
        - description
        - status
        - created_at
        - updated_at
        - last_time
        - last_source_time
        - settings
      properties:
        integration_id:
          type: integer
          format: int64
          description: Dedicated integration ID; use this ID for subsequent API calls.
        channel_id:
          type: integer
          format: int64
          description: ID of the channel that owns the dedicated integration.
        integration_key:
          type: string
          description: >-
            Complete integration key for alert ingestion; separate from the
            management App Key.
        exclusive_data_source_id:
          type: integer
          format: int64
          description: >-
            Compatibility identifier for earlier integrations; `0` when absent.
            Use `integration_id` for this API group.
        plugin_id:
          type: integer
          format: int64
          description: >-
            Numeric integration type ID. Create uses the string `plugin_type`
            instead.
        plugin_type:
          type: string
          description: Integration type identifier, such as `standard.alert`.
        plugin_type_name:
          type: string
          description: Integration type display name, localized to the request language.
        category:
          type: string
          description: >-
            Integration category; dedicated integration creation accepts
            `event.alert` alert integrations.
        name:
          type: string
          description: Integration name.
        description:
          type: string
          description: Integration description; empty when unset.
        status:
          type: string
          enum:
            - enabled
            - disabled
          description: >-
            Lifecycle status: `enabled` accepts alerts; `disabled` pauses
            ingestion.
        created_at:
          type: integer
          format: int64
          description: Creation time as a Unix timestamp in seconds.
        updated_at:
          type: integer
          format: int64
          description: Last update time as a Unix timestamp in seconds.
        last_time:
          type: integer
          format: int64
          description: >-
            Most recent received-event time as a Unix timestamp in seconds; `0`
            when no event has arrived.
        last_source_time:
          type: integer
          format: int64
          description: >-
            Source time of the most recent event as a Unix timestamp in seconds;
            `0` when unavailable.
        settings:
          type: object
          additionalProperties: true
          description: >-
            Integration-type-specific configuration; saved secret values in
            responses are masked as `******`.
    ErrorResponse:
      type: object
      description: Response envelope for errors. `error` is required; `data` is absent.
      properties:
        request_id:
          type: string
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          description: >-
            Unique trace ID of this request; include it when reporting issues so
            logs can be located.
        error:
          $ref: '#/components/schemas/DutyError'
      required:
        - request_id
        - error
    DutyError:
      type: object
      description: >-
        Error payload inside the response envelope. Present only on non-2xx
        responses.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: >-
            Human-readable error message in the response language (`locale` /
            `lang` query parameter or `Accept-Language` header). May name the
            offending field; do not parse it.
          example: The specified parameter template_id is not valid.
      required:
        - code
        - message
    ErrorCode:
      type: string
      description: >-
        Error code. Every failed response sets `error.code` to one of these
        stable strings; branch on it rather than on the HTTP status.


        | Code | HTTP | Meaning |

        |---|---|---|

        | `OK` | 200 | Reserved; never returned on a failed request. |

        | `InvalidParameter` | 400 | A parameter is missing, has the wrong type,
        or failed validation; `message` usually names the field. |

        | `BadRequest` | 400 | The request breaks a business rule or conflicts
        with the current state of an object; `message` says which. |

        | `InvalidContentType` | 400 | The body is not sent as
        `application/json`. |

        | `ResourceNotFound` | 400 | The referenced object does not exist in
        this account or was deleted. Returned as HTTP 400, not 404. |

        | `NoLicense` | 400 | The account's plan does not include the feature, a
        plan quota is used up, the plan has expired, or credits are
        insufficient. |

        | `ReferenceExist` | 400 | The object is still referenced by other
        objects, so it cannot be deleted. |

        | `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |

        | `BalanceNotEnough` | 402 | Console-only (billing); not returned by
        Open API operations. |

        | `AccessDenied` | 403 | The APP Key's permission scope or the creator's
        role does not allow this operation or object. |

        | `RouteNotFound` | 404 | No operation matches the HTTP method and path.
        |

        | `MethodNotAllowed` | 405 | The path exists but not for this HTTP
        method. |

        | `UndonedOrderExist` | 409 | Console-only (billing); not returned by
        Open API operations. |

        | `EntityTooLarge` | 413 | The request body exceeds the size limit. |

        | `RequestLocked` | 423 | Console-only (sign-in protection); not
        returned by Open API operations. |

        | `RequestVerifyRequired` | 428 | Console-only (verification code); not
        returned by Open API operations. |

        | `DangerousOperation` | 428 | Console-only (MFA for high-risk actions);
        not returned by Open API operations. |

        | `RequestTooFrequently` | 429 | A rate limit was hit; wait for the
        `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before
        retrying. |

        | `InternalError` | 500 | Unexpected server error; retry with backoff
        and include `request_id` when reporting. |

        | `ServiceUnavailable` | 503 | A backend dependency is overloaded or
        unavailable; retry with backoff. |
      enum:
        - OK
        - InvalidParameter
        - BadRequest
        - InvalidContentType
        - ResourceNotFound
        - NoLicense
        - ReferenceExist
        - Unauthorized
        - BalanceNotEnough
        - AccessDenied
        - RouteNotFound
        - MethodNotAllowed
        - UndonedOrderExist
        - EntityTooLarge
        - RequestLocked
        - RequestVerifyRequired
        - DangerousOperation
        - RequestTooFrequently
        - InternalError
        - ServiceUnavailable
      x-enumDescriptions:
        OK: Reserved; never returned on a failed request.
        InvalidParameter: >-
          A parameter is missing, has the wrong type, or failed validation;
          `message` usually names the field.
        BadRequest: >-
          The request breaks a business rule or conflicts with the current state
          of an object; `message` says which.
        InvalidContentType: The body is not sent as `application/json`.
        ResourceNotFound: >-
          The referenced object does not exist in this account or was deleted.
          Returned as HTTP 400, not 404.
        NoLicense: >-
          The account's plan does not include the feature, a plan quota is used
          up, the plan has expired, or credits are insufficient.
        ReferenceExist: >-
          The object is still referenced by other objects, so it cannot be
          deleted.
        Unauthorized: The APP Key is missing, invalid, or deleted.
        BalanceNotEnough: Console-only (billing); not returned by Open API operations.
        AccessDenied: >-
          The APP Key's permission scope or the creator's role does not allow
          this operation or object.
        RouteNotFound: No operation matches the HTTP method and path.
        MethodNotAllowed: The path exists but not for this HTTP method.
        UndonedOrderExist: Console-only (billing); not returned by Open API operations.
        EntityTooLarge: The request body exceeds the size limit.
        RequestLocked: >-
          Console-only (sign-in protection); not returned by Open API
          operations.
        RequestVerifyRequired: Console-only (verification code); not returned by Open API operations.
        DangerousOperation: >-
          Console-only (MFA for high-risk actions); not returned by Open API
          operations.
        RequestTooFrequently: >-
          A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay`
          response header (seconds) before retrying.
        InternalError: >-
          Unexpected server error; retry with backoff and include `request_id`
          when reporting.
        ServiceUnavailable: A backend dependency is overloaded or unavailable; retry with backoff.
      example: InvalidParameter
  responses:
    BadRequest:
      description: Invalid request — usually a missing or malformed parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingParameter:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InvalidParameter
                  message: The specified parameter is not valid.
    Unauthorized:
      description: Missing or invalid app_key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingAppKey:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: Unauthorized
                  message: You are unauthorized.
    Forbidden:
      description: >-
        The app_key is valid, but its permission scope or the creator's role
        does not allow this operation or object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            noEditPermission:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: AccessDenied
                  message: Access Denied.
    TooManyRequests:
      description: >-
        Rate limit hit. Wait for the number of seconds in
        `Flashcat-Request-Rate-Limit-Delay`, then retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: RequestTooFrequently
                  message: Request too frequently.
      headers:
        Flashcat-Request-Rate-Limit-Delay:
          description: >-
            Seconds until the current rate-limit window resets. Absent when the
            request was rejected by the gateway's global protection limit.
          schema:
            type: integer
            minimum: 0
    ServerError:
      description: Unexpected server-side error. Include the request_id when reporting.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InternalError
                  message: >-
                    We encountered an internal error, and it has been reported.
                    Please try again later.
  securitySchemes:
    AppKeyAuth:
      type: apiKey
      in: query
      name: app_key
      description: >-
        APP Key created in the Flashduty console under My → APP Key. Send it as
        the `app_key` query parameter or in the `Fd-App-Key` request header. Its
        effective access is the intersection of the key's permission scope and
        the creator's current role permissions. Keep it secret.

````

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