Get a list

Returns a list based on the list ID provided.

URL: https://api.courier.com/lists/:list_id

Method: GET

Path Parameters

list_idstringrequired

A unique identifier associated with the list you wish to retrieve.

Responses

status: 200 OK

createdstring

The date/time of when the list was created. Represented as a string in ISO format.

idstring

List Identifier

namestring

List name

updatedstring

The date/time of when the list was updated. Represented as a string in ISO format.

preferencesobject

+ Show Properties

status: 404 Not Found

messagestring

A message describing the error that occurred.

typestring

[invalid_request_error] The type of error that occurred.

Request Example

cURL

curl --request GET \
     --url https://api.courier.com/lists/example.list.id \
     --header 'Accept: application/json' 

Node.js

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json'
  },
};

fetch('https://api.courier.com/lists/example.list.id', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/lists/example.list.id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'

response = http.request(request)
puts response.read_body

Python

# Dependencies to install:
# $ python -m pip install requests

import requests

url = "https://api.courier.com/lists/example.list.id"

headers = {
  "Accept": "application/json"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.courier.com/lists/example.list.id"

  req, _ := http.NewRequest("GET", url, payload)

  req.Header.Add("Accept", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

PHP

<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.courier.com/lists/example.list.id', [
  'headers' => [
    'Accept' => 'application/json',
  ],
]);

echo $response->getBody();

Responses Example

{
  "created": "2020-06-10T18:41:29.093Z",
  "id": "example.list.id",
  "name": "Example List Name",
  "updated": "2020-06-10T18:41:29.093Z",
  "preferences": {
    "notifications": {
      "{KEY}": {
        "channel_preferences": [
          {
            "channel": "push"
          }
        ],
        "rules": [
          {
            "type": "snooze",
            "start": "2021-08-23T23:27:41+00:00",
            "until": "2022-09-16T23:27:41+00:00"
          }
        ],
        "status": "OPTED_IN"
      }
    },
    "categories": {
      "{KEY}": {
        "channel_preferences": [
          {
            "channel": "push"
          }
        ],
        "rules": [
          {
            "type": "snooze",
            "start": "2021-08-23T23:27:41+00:00",
            "until": "2022-09-16T23:27:41+00:00"
          }
        ],
        "status": "OPTED_IN"
      }
    }
  }
}

{
  "message": "Not Found",
  "type": "invalid_request_error"
}