Skip to main content
GET
/
notifications
/
{id}
/
{submissionId}
/
checks
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const checks = await client.notifications.checks.list('submissionId', { id: 'id' });

console.log(checks.checks);
import os
from courier import Courier

client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
checks = client.notifications.checks.list(
submission_id="submissionId",
id="id",
)
print(checks.checks)
package main

import (
"context"
"fmt"

"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)

func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
checks, err := client.Notifications.Checks.List(
context.TODO(),
"submissionId",
courier.NotificationCheckListParams{
ID: "id",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", checks.Checks)
}
package com.courier.example;

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.notifications.checks.CheckListParams;
import com.courier.models.notifications.checks.CheckListResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();

CheckListParams params = CheckListParams.builder()
.id("id")
.submissionId("submissionId")
.build();
CheckListResponse checks = client.notifications().checks().list(params);
}
}
require "courier"

courier = Courier::Client.new(api_key: "My API Key")

checks = courier.notifications.checks.list("submissionId", id: "id")

puts(checks)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Courier\Client;
use Courier\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');

try {
$checks = $client->notifications->checks->list('submissionId', id: 'id');

var_dump($checks);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using TryCourier;
using TryCourier.Models.Notifications.Checks;

CourierClient client = new();

CheckListParams parameters = new()
{
ID = "id",
SubmissionID = "submissionId",
};

var checks = await client.Notifications.Checks.List(parameters);

Console.WriteLine(checks);
courier notifications:checks list \
--api-key 'My API Key' \
--id id \
--submission-id submissionId
curl --request GET \
--url https://api.courier.com/notifications/{id}/{submissionId}/checks \
--header 'Authorization: Bearer <token>'
{
  "checks": [
    {
      "id": "abc-123",
      "status": "RESOLVED",
      "type": "custom",
      "updated": 1
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Notification template ID.

submissionId
string
required

Submission ID.

Response

200 - application/json

Submission checks retrieved.

checks
Check · object[]
required