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 subscriptionList = await client.lists.retrieve('list_id');
console.log(subscriptionList.id);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
subscription_list = client.lists.retrieve(
"list_id",
)
print(subscription_list.id)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"),
)
subscriptionList, err := client.Lists.Get(context.TODO(), "list_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", subscriptionList.ID)
}package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.lists.ListRetrieveParams;
import com.courier.models.lists.SubscriptionList;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
SubscriptionList subscriptionList = client.lists().retrieve("list_id");
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
subscription_list = courier.lists.retrieve("list_id")
puts(subscription_list)<?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 {
$subscriptionList = $client->lists->retrieve('list_id');
var_dump($subscriptionList);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using TryCourier.Models.Lists;
CourierClient client = new();
ListRetrieveParams parameters = new() { ListID = "list_id" };
var subscriptionList = await client.Lists.Retrieve(parameters);
Console.WriteLine(subscriptionList);courier lists retrieve \
--api-key 'My API Key' \
--list-id list_idcurl --request GET \
--url https://api.courier.com/lists/{list_id} \
--header 'Authorization: Bearer <token>'{
"id": "example.list.id",
"name": "Example List",
"created": "2024-01-15T10:30:00.000Z",
"updated": "2024-01-15T10:30:00.000Z"
}{
"message": "Example message text",
"type": "invalid_request_error"
}Lists
Get a list
Returns a list based on the list ID provided.
GET
/
lists
/
{list_id}
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 subscriptionList = await client.lists.retrieve('list_id');
console.log(subscriptionList.id);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
subscription_list = client.lists.retrieve(
"list_id",
)
print(subscription_list.id)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"),
)
subscriptionList, err := client.Lists.Get(context.TODO(), "list_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", subscriptionList.ID)
}package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.lists.ListRetrieveParams;
import com.courier.models.lists.SubscriptionList;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
SubscriptionList subscriptionList = client.lists().retrieve("list_id");
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
subscription_list = courier.lists.retrieve("list_id")
puts(subscription_list)<?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 {
$subscriptionList = $client->lists->retrieve('list_id');
var_dump($subscriptionList);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using TryCourier.Models.Lists;
CourierClient client = new();
ListRetrieveParams parameters = new() { ListID = "list_id" };
var subscriptionList = await client.Lists.Retrieve(parameters);
Console.WriteLine(subscriptionList);courier lists retrieve \
--api-key 'My API Key' \
--list-id list_idcurl --request GET \
--url https://api.courier.com/lists/{list_id} \
--header 'Authorization: Bearer <token>'{
"id": "example.list.id",
"name": "Example List",
"created": "2024-01-15T10:30:00.000Z",
"updated": "2024-01-15T10:30:00.000Z"
}{
"message": "Example message text",
"type": "invalid_request_error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A unique identifier representing the list you wish to retrieve.
โI