Retrieve List Details

Use this endpoint to get details on a particular list in Engage.

Endpoint and Methods

GET /_rest/v2/lists

Parameters

Note: Either the "Id" or "Name" parameter is required.

  • Id:

    • Key = id; Value = campaignId

  • Name:

    • Key = name; Value = campaignName

Sample Request

Example with Id:

GET /_rest/v2/lists?id=5f7ca4beb854df0ac6b8bee1

Example with Name:

GET /_rest/v2/lists?name=JC C

Note: Your query must include at least four characters and spaces are allowed.

Sample Responses

Code 200 Response

Response code 200 returns a list object when a list was successfully created.

Copy
{
"listName": "Bob's List",
"listId": "51i8c0edotame81bb4cbf000",
"description": "List of Bob's contacts",
"customerId": 9999999,
"modifiedDate": "2019-06-18T00:14:03Z",
"modifiedBy": "sspeirs",
"createdDate": "2019-06-18T00:14:03Z",
"createdBy": "sspeirs",
"deleteFlag": "false",
"campaignRel": [
"4kk11065jkl0985bb48mf054"
],
"contactRel": [
"4kk11065jkl0985bb48mf054"
]
}

Code 401 Response

Response code 401 returns an error that the authorization token is invalid.

Copy
{
"message": "string",
"status": 401
}

Code 404 Response

Response code 404 returns a message that the campaign id or name is wrong and the campaign is not found.

Code 422 Response

Response code 422 returns a message that the name parameter was less than four characters and the list details could not be retrieved.

Code 500 Response

Response code 500 returns an error when trying to retrieve list details.

Copy
{
"message": "Something went wrong when trying to get list details",
"status": 500
}