Contents x
    通知先一覧取得
      • Print
      • PDF
      Contents

      通知先一覧取得

        • Print
        • PDF
        Article summary

        Get
        /api/notification_destinations/{type}

        通知先（email または slack_channel）の一覧を取得します。
        type=email または type=slack_channel を指定することで、種類を絞り込むことができます。

        Security
        API Key
        Header parameter nameAuthorization

        認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
        API KEYがabc123の場合は、Authorization: Token abc123とします。
        API KEYの作成方法は、trocco APIについてを参照ください。

        Path parameters
        type
        stringRequired

        通知先の種類です（email または slack_channel）。

        Valid values[ "email", "slack_channel" ]
        Exampleemail
        Query parameters
        limit
        integer (int64)

        取得する通知先一覧の最大件数

        Maximum200
        Default50
        Example10
        cursor
        string

        取得する通知先一覧の最初のレコードを示すページネーションカーソル。
        レスポンスに含まれる next_cursor を指定することで、後続のデータを取得できます。

        ExampleeyJpZCI6MjF9
        Responses
        200

        通知先一覧を返します。

        Expand All
        object
        items
        Array of object
        object
        Example{ "id": 1, "type": "email", "email": "test@example.com" }
        id
        integer (int64)

        通知先のIDです。

        type
        string

        通知先の種類です。

        Valid values[ "email", "slack_channel" ]
        Exampleemail
        email
        string

        type=email の場合に設定されるメールアドレスです。

        Exampletest@example.com
        channel
        string | null

        type=slack_channel の場合に設定されるチャンネル名です。

        Example#general
        next_cursor
        string

        後続のページネーションリクエストの取得開始レコードを示すカーソル値です。

        401

        認証エラーです。API KEYをご確認ください。

        404

        指定した通知先が存在しません。

        Was this article helpful?
        What's Next