lists

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-lists"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/dea5db4d-524b-41d3-8271-fa7e50897c07/social-card.svg?v=3e7ae33eec8b" alt="lists" width="600" height="315"></a>
GEThttps://hermetica.15.204.158.166.sslip.io/v1/lists

Lists with member counts; `count`/`offset` page them, `stats=true` adds send and unsubscribe stats

Parameters

idsstringquery
Comma separated list ids: only these lists
tagstringquery
qstringquery
folderIdstringquery
unfiledstringquery
true
archivedstringquery
true | false
countintegerquery
offsetintegerquery
= 0
createdSincequery
createdBeforequery
emailstringquery
statsstringquery
true

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/lists" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "kind": "string",
      "settings": {
        "doubleOptIn": true,
        "subscribeAddress": "string",
        "permissionReminder": "string",
        "defaultFromName": "string",
        "defaultFromEmail": "string",
        "defaultSubject": "string",
        "defaultReplyTo": "string",
        "allowedFormTags": [
          "string"
        ],
        "defaultLanguage": "string",
        "companyName": "string",
        "contactAddress": "string",
        "postalAddressId": "string",
        "footer": "string",
        "contactEmail": "string",
        "homepageUrl": "string",
        "segmentScopeId": "string",
        "unsubscribeMode": "confirm",
        "unsubscribeRedirectUrl": "string",
        "unsubscribedMessage": "string",
        "notifyOnSubscribe": "string",
        "notifyOnUnsubscribe": "string",
        "archived": true,
        "emoji": "string",
        "publicDirectory": true,
        "expiresAt": "2024-01-01T00:00:00Z",
        "exclusion": true,
        "defaultConnectionId": "string",
        "defaultPoolId": "string"
      },
      "tags": [
        "string"
      ],
      "folderId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "memberCount": 0,
      "stats": {
        "sent": 0,
        "openRate": 0,
        "clickRate": 0,
        "unsubscribed": 0,
        "cleaned": 0,
        "lastSentAt": "string"
      }
    }
  ],
  "total": 0
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
namestringrequired
descriptionstringrequired
kindstringrequired
settingsobjectrequired
Show child parameters
doubleOptInboolean
subscribeAddressstring
permissionReminderstring
defaultFromNamestring
defaultFromEmailstring
defaultSubjectstring
defaultReplyTostring
allowedFormTagsstring[]
defaultLanguagestring
companyNamestring
contactAddressstring
postalAddressIdstring
footerstring
contactEmailstring
homepageUrlstring
segmentScopeIdstring
unsubscribeModestring
confirm | one_click
unsubscribeRedirectUrlstring
unsubscribedMessagestring
notifyOnSubscribestring
notifyOnUnsubscribestring
archivedboolean
emojistring
publicDirectoryboolean
expiresAtstring
exclusionboolean
defaultConnectionIdstring
defaultPoolIdstring
tagsstring[]
folderIdstring
createdAtstringrequired
memberCountintegerrequired
statsobject
Show child parameters
sentintegerrequired
openRatenumberrequired
clickRatenumberrequired
unsubscribedintegerrequired
cleanedintegerrequired
lastSentAtstringrequired
totalintegerrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/lists

POSThttps://hermetica.15.204.158.166.sslip.io/v1/lists

Request body

application/json
namestringrequired
descriptionstring
settingsobject
Show child parameters
doubleOptInboolean
subscribeAddressstring
permissionReminderstring
defaultFromNamestring
defaultFromEmailstring
defaultSubjectstring
defaultReplyTostring
allowedFormTagsstring[]
defaultLanguagestring
companyNamestring
contactAddressstring
postalAddressIdstring
footerstring
contactEmailstring
homepageUrlstring
segmentScopeIdstring
unsubscribeModestring
confirm | one_click
unsubscribeRedirectUrlstring
unsubscribedMessagestring
notifyOnSubscribestring
notifyOnUnsubscribestring
archivedboolean
emojistring
publicDirectoryboolean
expiresAtstring
exclusionboolean
defaultConnectionIdstring
defaultPoolIdstring
folderIdstring
{
  "name": "string",
  "description": "string",
  "settings": {
    "doubleOptIn": true,
    "subscribeAddress": "string",
    "permissionReminder": "string",
    "defaultFromName": "string",
    "defaultFromEmail": "string",
    "defaultSubject": "string",
    "defaultReplyTo": "string",
    "allowedFormTags": [
      "string"
    ],
    "defaultLanguage": "string",
    "companyName": "string",
    "contactAddress": "string",
    "postalAddressId": "string",
    "footer": "string",
    "contactEmail": "string",
    "homepageUrl": "string",
    "segmentScopeId": "string",
    "unsubscribeMode": "confirm",
    "unsubscribeRedirectUrl": "string",
    "unsubscribedMessage": "string",
    "notifyOnSubscribe": "string",
    "notifyOnUnsubscribe": "string",
    "archived": true,
    "emoji": "string",
    "publicDirectory": true,
    "expiresAt": "2024-01-01T00:00:00Z",
    "exclusion": true,
    "defaultConnectionId": "string",
    "defaultPoolId": "string"
  },
  "folderId": "string"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/lists" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","settings":{"doubleOptIn":true,"subscribeAddress":"string","permissionReminder":"string","defaultFromName":"string","defaultFromEmail":"string","defaultSubject":"string","defaultReplyTo":"string","allowedFormTags":["string"],"defaultLanguage":"string","companyName":"string","contactAddress":"string","postalAddressId":"string","footer":"string","contactEmail":"string","homepageUrl":"string","segmentScopeId":"string","unsubscribeMode":"confirm","unsubscribeRedirectUrl":"string","unsubscribedMessage":"string","notifyOnSubscribe":"string","notifyOnUnsubscribe":"string","archived":true,"emoji":"string","publicDirectory":true,"expiresAt":"2024-01-01T00:00:00Z","exclusion":true,"defaultConnectionId":"string","defaultPoolId":"string"},"folderId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "kind": "string",
  "settings": {
    "doubleOptIn": true,
    "subscribeAddress": "string",
    "permissionReminder": "string",
    "defaultFromName": "string",
    "defaultFromEmail": "string",
    "defaultSubject": "string",
    "defaultReplyTo": "string",
    "allowedFormTags": [
      "string"
    ],
    "defaultLanguage": "string",
    "companyName": "string",
    "contactAddress": "string",
    "postalAddressId": "string",
    "footer": "string",
    "contactEmail": "string",
    "homepageUrl": "string",
    "segmentScopeId": "string",
    "unsubscribeMode": "confirm",
    "unsubscribeRedirectUrl": "string",
    "unsubscribedMessage": "string",
    "notifyOnSubscribe": "string",
    "notifyOnUnsubscribe": "string",
    "archived": true,
    "emoji": "string",
    "publicDirectory": true,
    "expiresAt": "2024-01-01T00:00:00Z",
    "exclusion": true,
    "defaultConnectionId": "string",
    "defaultPoolId": "string"
  },
  "tags": [
    "string"
  ],
  "folderId": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
descriptionstringrequired
kindstringrequired
settingsobjectrequired
Show child parameters
doubleOptInboolean
subscribeAddressstring
permissionReminderstring
defaultFromNamestring
defaultFromEmailstring
defaultSubjectstring
defaultReplyTostring
allowedFormTagsstring[]
defaultLanguagestring
companyNamestring
contactAddressstring
postalAddressIdstring
footerstring
contactEmailstring
homepageUrlstring
segmentScopeIdstring
unsubscribeModestring
confirm | one_click
unsubscribeRedirectUrlstring
unsubscribedMessagestring
notifyOnSubscribestring
notifyOnUnsubscribestring
archivedboolean
emojistring
publicDirectoryboolean
expiresAtstring
exclusionboolean
defaultConnectionIdstring
defaultPoolIdstring
tagsstring[]
folderIdstring
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists

5XX Default Response

Same as 4XX · GET /v1/lists

POSThttps://hermetica.15.204.158.166.sslip.io/v1/lists/batch/delete

Delete many lists at once (each can be restored); an unknown id fails the whole call

Request body

application/json
idsstring[]
searchstring
{
  "ids": [
    "string"
  ],
  "search": "string"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/lists/batch/delete" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"search":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "deleted": [
    "string"
  ]
}
Schema
deletedstring[]required
4XX Default Response

Same as 4XX · GET /v1/lists

5XX Default Response

Same as 4XX · GET /v1/lists

GEThttps://hermetica.15.204.158.166.sslip.io/v1/lists/deleted

Lists deleted and still restorable

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/lists/deleted" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "kind": "string",
      "settings": {
        "doubleOptIn": true,
        "subscribeAddress": "string",
        "permissionReminder": "string",
        "defaultFromName": "string",
        "defaultFromEmail": "string",
        "defaultSubject": "string",
        "defaultReplyTo": "string",
        "allowedFormTags": [
          "string"
        ],
        "defaultLanguage": "string",
        "companyName": "string",
        "contactAddress": "string",
        "postalAddressId": "string",
        "footer": "string",
        "contactEmail": "string",
        "homepageUrl": "string",
        "segmentScopeId": "string",
        "unsubscribeMode": "confirm",
        "unsubscribeRedirectUrl": "string",
        "unsubscribedMessage": "string",
        "notifyOnSubscribe": "string",
        "notifyOnUnsubscribe": "string",
        "archived": true,
        "emoji": "string",
        "publicDirectory": true,
        "expiresAt": "2024-01-01T00:00:00Z",
        "exclusion": true,
        "defaultConnectionId": "string",
        "defaultPoolId": "string"
      },
      "tags": [
        "string"
      ],
      "folderId": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
namestringrequired
descriptionstringrequired
kindstringrequired
settingsobjectrequired
Show child parameters
doubleOptInboolean
subscribeAddressstring
permissionReminderstring
defaultFromNamestring
defaultFromEmailstring
defaultSubjectstring
defaultReplyTostring
allowedFormTagsstring[]
defaultLanguagestring
companyNamestring
contactAddressstring
postalAddressIdstring
footerstring
contactEmailstring
homepageUrlstring
segmentScopeIdstring
unsubscribeModestring
confirm | one_click
unsubscribeRedirectUrlstring
unsubscribedMessagestring
notifyOnSubscribestring
notifyOnUnsubscribestring
archivedboolean
emojistring
publicDirectoryboolean
expiresAtstring
exclusionboolean
defaultConnectionIdstring
defaultPoolIdstring
tagsstring[]
folderIdstring
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists

5XX Default Response

Same as 4XX · GET /v1/lists

POSThttps://hermetica.15.204.158.166.sslip.io/v1/lists/{id}/restore

Undo a list delete; members come back with it

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/lists/{id}/restore" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/lists

4XX Default Response

Same as 4XX · GET /v1/lists

5XX Default Response

Same as 4XX · GET /v1/lists

Updated