Follow

Get List by Name

The Get List by Name command allows you to get the properties of a List specified by the List ID.

GET /lists?listName=[listName]

https://[siteurl]/rest/lists?listName=[listName]

Request Body Parameters

The Get List by Name command requires only the URI call with the List Name. No additional fields are required in the JSON.  

The query string 'listName' is case sensitive and must be defined as in the example above.  If the query string is incorrect, it is ignored and the command returns all Lists in the Account, like the Get All Lists command.

If the List Name contains spaces, URL encode the space with '%20', for instance:

  • My List

    becomes

  • My%20List

Request Body Example

Using Get List:

curl --request GET \ 
--url 'https://mail.mydomain.com/rest/lists?listName=myList' \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'accept: application/vnd.whatcounts-v1+json' \
--header 'content-type: application/json' \
--include

Response Body

The response returns all API available List Properties in JSON format for the specified List.

Based on the example above, the response returns:


HTTP/1.1 200 OK
Server: serverName
Content-Type: application/json
Link: <https://mail.mydomain.com/rest/lists?listName=myList>;
Date: Fri, 17 Jun 2016 12:54:44 GMT
{
"listFromAddress": "from@mydomain.com"
"listReplyToAddress": "replyto@mydomain.com"
"listMailFromAddress": "bounce??EMAIL_REF??@mail.mydomain.com"
"listDescription": "My Subscriber List"
"listAdminEmail": "myemail@mydomain.com"
"listCreatedDate": "Jun 17, 2016 12:54:44 PM"
"listUpdatedDate": "Jun 17, 2016 12:54:44 PM"
"parentTemplateId": 0
"isTemplate": false
"listSubscribeEmailTemplateId": 0
"listUnsubscribeEmailTemplateId": 0
"listConfirmSubs": false
"listSendCourtesySubsEmail": false
"listSendCourtesyUnsubsEmail": false
"listConfirmationSubGoto": ""
"listConfirmationUnsubGoto": ""
"listTrackingReadEnabled": true
"listTrackingClickthroughEnabled": true
"listUseStickyCampaign": false
"ftafUseListFromAddress": false
"vmtaId": 0
"baseUrlId": 0
"unsubscribeHeaderEnabled": false
"defaultLifecycleCampaignId": 0
"defaultLifecycle": false
"unsubHeaderHttpValue": ""
"unsubHeaderEmailValue": ""
"listId": 10
"listRealmId": 1561
"listTemplateId": 0
"type": 0
"listName": "myList"
"listFolderId": 0
"subscriberCountTotal": 0
"subscriberCountPlain": 0
"subscriberCountHtml": 0
"subscriberCountRss": 0
"subscriberCountMime": 0
"skip": 0
"max": 0
}

Error Response

Error Response Codes include both Client Errors (4xx) and Server Errors (5xx).  Descriptions of each can be found in Response Codes

For example, if the specified List does not exist, the error would appear as:

{
"error": "Failed: Unable to find resource"
"status": "Not Found"
"statusCode": 404
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk