Retrieve contacts from a temporary mailing list.
GET
https://www.prayerletters.com/api/v1/lists/{list_id}
URL Parameters
- list_id
- The ID of the list to be retrieved.
Successful Response
HTTP/1.1 200 OK
{
"data" : [
{
"address" : {
"city" : "Lebanon",
"country" : null,
"postal_code" : "03766",
"state" : "NH",
"street" : "123 Main St."
},
"company" : null,
"external_id" : "0123456",
"file_as" : "Tischler, Joe and Mary",
"greeting" : "Joe and Mary",
"id" : "a-22m-zqfb",
"metadata" : {
"amount" : "$50.00"
},
"name" : "Joe and Mary Tischler",
"type" : "contact"
},
{
"address" : {
"city" : "West Lebanon",
"country" : null,
"postal_code" : "03784",
"state" : "NH",
"street" : "30 Airport Road, Suite 1"
},
"company" : "prayerletters.com",
"external_id" : null,
"file_as" : "prayerletters.com",
"id" : "a-13z-ynwq",
"metadata" : {
"amount" : "$100.00"
},
"name" : "Customer Service",
"type" : "contact"
}
],
"links" : {
"self" : "https://www.prayerletters.com/api/v1/lists/l-0jr-f5eh/contacts?page[limit]=100&page[offset]=0"
},
"type" : "contacts"
}
Error Response
- 403 lists.permission_error
- You need the
lists.read
scope to perform this action.
API Basics
Contacts API
Files API
Fonts API
Lists API
Logos API
Payment API
Stock API
Webhooks API