Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/emaiList/list

Descriptor

Value

HTTP Method

GET

Description

Retrieves all email lists.

Required Permission

Manage Email Reports (Global level)

Version Introduced

2.7.4

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

Sample Call:

Code Block
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/emailList/list

Sample Output:

Code Block
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 1,
            "name": "List",
            "emailAddresses": [
                "test@domain.com",
                "test2@domain.com",
                "test3@domain.com"
            ]
        },
        {
            "id": 2,
            "name": "Second List",
            "emailAddresses": []
        }
    ]
}

Page Tree
rootEmail Reporting API 3.0 - WIP