GET /lists
URL: https://api.courier.com/lists
Method: GET
Query Parameters
cursorstring
A unique identifier that allows for fetching the next set of lists.
patternstring
A pattern used to filter the list items returned. Pattern types supported: exact match on
list_id
or a pattern of one or more pattern parts. you may replace a part with either: *
to match all parts in that position, or **
to signify a wildcard endsWith
pattern match.Response
status: 200 OK
pagingobject
+ Show Properties
resultsarray
+ Show Properties
Request Example
- cURL
- Node.js
- Ruby
- Python
- Go
- PHP
curl --request GET \
--url https://api.courier.com/lists?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA%3D%3D&pattern=exact-list-id%20OR%20example.%2A%2C%20example.%2A%2A%2C%20example.%2A.list \
--header 'Accept: application/json'
// 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?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA%3D%3D&pattern=exact-list-id%20OR%20example.%2A%2C%20example.%2A%2A%2C%20example.%2A.list', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.courier.com/lists?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA%3D%3D&pattern=exact-list-id%20OR%20example.%2A%2C%20example.%2A%2A%2C%20example.%2A.list")
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
# Dependencies to install:
# $ python -m pip install requests
import requests
url = "https://api.courier.com/lists?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA%3D%3D&pattern=exact-list-id%20OR%20example.%2A%2C%20example.%2A%2A%2C%20example.%2A.list"
headers = {
"Accept": "application/json"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.courier.com/lists?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA%3D%3D&pattern=exact-list-id%20OR%20example.%2A%2C%20example.%2A%2A%2C%20example.%2A.list"
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
// 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?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA%3D%3D&pattern=exact-list-id%20OR%20example.%2A%2C%20example.%2A%2A%2C%20example.%2A.list', [
'headers' => [
'Accept' => 'application/json',
],
]);
echo $response->getBody();
Responses Example
{
"paging": {
"cursor": "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA==",
"more": true
},
"results": [
{
"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"
}
],
"status": "OPTED_IN"
}
},
"categories": {
"{KEY}": {
"channel_preferences": [
{
"channel": "push"
}
],
"rules": [
{
"type": "snooze"
}
],
"status": "OPTED_IN"
}
}
}
}
]
}