Retrieve List Details

Use id to get details on a particular list in Engage.

 

Endpoint and methods
  • GET: /api/v2/lists/:id

 

Parameters

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

 

 {
"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"
]
}

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

 

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

Response code 422 returns a message that the id parameter is required.

 

{
"message": "The 'id' parameter is required",
"status": 422
}

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

 

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