All Resources
Lists

The resources and methods under /Lists facilitate List and Output maintenance and use.

Http Verb Operation
Get Reporting/Lists/{listId} Get a single List without contents.
GET Method: Get, URL: Reporting/Lists/{listId} Test

Get a single List without contents.
GetContents Reporting/Lists/{listId}/Contents Gets Constituent ids for the contents of a List.
GET Method: GetContents, URL: Reporting/Lists/{listId}/Contents Test

Gets Constituent ids for the contents of a List.
GetContentsDetail Reporting/Lists/{listId}/Contents/Details Gets Constituent details for the contents of a List.
GET Method: GetContentsDetail, URL: Reporting/Lists/{listId}/Contents/Details Test

Gets Constituent details for the contents of a List.
GetListCriterionMatchReasons Reporting/Lists/{listId}/Contents/{constituentId}/MatchReasons Returns list criteria match reasons for a constituent in a list.
GET Method: GetListCriterionMatchReasons, URL: Reporting/Lists/{listId}/Contents/{constituentId}/MatchReasons Test

Returns list criteria match reasons for a constituent in a list.
GetSummaries Reporting/Lists/Summary?listIds={listIds} Get a summary of all Lists.
GET Method: GetSummaries, URL: Reporting/Lists/Summary?listIds={listIds} Test

Get a summary of all Lists.
Create Reporting/Lists Create a List.
POST Method: Create, URL: Reporting/Lists Test

Create a List.
Generate Reporting/Lists/{listId}/Generate Generate a List.
POST Method: Generate, URL: Reporting/Lists/{listId}/Generate Test

Generate a List.
Results Reporting/Lists/{listId}/Results Get results for List and OutputSet combination. If no outputSetId is passed in the request, a default output set must be set for the list. Response returns custom HTTP headers: X-Page, X-Page-Size, and X-Total-Count. Default page is 1 and default page size is 100.
POST Method: Results, URL: Reporting/Lists/{listId}/Results Test

Get results for List and OutputSet combination. If no outputSetId is passed in the request, a default output set must be set for the list.

Search Reporting/Lists/Search Search for List. Response returns custom HTTP headers: X-Page, X-Page-Size, and X-Total-Count. Default page is 1 and default page size is 50.

Search for List. Response returns custom HTTP headers: X-Page, X-Page-Size, and X-Total-Count. Default page is 1 and default page size is 50.
Update Reporting/Lists/{listId} Update an existing List.
PUT Method: Update, URL: Reporting/Lists/{listId} Test

Update an existing List.
UpdateContents Reporting/Lists/{listId}/Contents Import constituent ids into an existing list.
PUT Method: UpdateContents, URL: Reporting/Lists/{listId}/Contents Test

Import constituent ids into an existing list.
Delete Reporting/Lists/{listId} Delete an existing List.
DELETE Method: Delete, URL: Reporting/Lists/{listId} Test

Delete an existing List.