Get HotList

This API operation returns a user's hotlist by specifying the hotlist id.

URL / Endpoint

GET /v1/HotLists/GetHotList

Request

Property	Type	Description
`ListID`	integer	Returns the hotlist with this id.
`ReturnMemberProfiles`	boolean	Returns the profile information for each member.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

This endpoint has the following optional headers:

Headers	Value
`X-MaskImages`	`1`	What's this?

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires the following scope:

Scope
`profile_hotlist`

Samples

GET method

https://api-sandbox.adultwork.com/v1/HotLists/GetHotList?ListId=1234

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`HotList`	aws:HotList	The hotlist data.

Response Sample

The following example shows a sample hotlist returned by the API.

JSON
XML

{
  "HotListDetails": {
    "UserID": 999,
    "ListID": 1000,
    "ListName": "Best of AW",
    "UserName": "Joe"
  },
  "HotListMembers": [
    {
      "UserID": 1234,
      "InteractionCount": 0,
      "UserName": "Jane",
      "Notes": null,
      "LastUpdated": "2016-03-26T18:20:55.14",
      "LastInteractionDate": "0001-01-01T00:00:00",
      "Profile": null
    },
    {
      "UserID": 12345,
      "InteractionCount": 0,
      "UserName": "Freddy",
      "Notes": "This is a note",
      "LastUpdated": "2015-12-18T14:51:33.12",
      "LastInteractionDate": "0001-01-01T00:00:00",
      "Profile": null
    }
  ]
}

<HotList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.HotLists">
    <HotListDetails>
        <ListID>1000</ListID>
        <ListName>Best of AW</ListName>
        <UserID>999</UserID>
        <UserName>Joe</UserName>
    </HotListDetails>
    <HotListMembers>
        <HotListMember>
            <InteractionCount>0</InteractionCount>
            <LastInteractionDate>0001-01-01T00:00:00</LastInteractionDate>
            <LastUpdated>2016-03-26T18:20:55.14</LastUpdated>
            <Notes i:nil="true" />
            <UserID>1234</UserID>
            <UserName>Jane</UserName>
        </HotListMember>
        <HotListMember>
            <InteractionCount>0</InteractionCount>
            <LastInteractionDate>0001-01-01T00:00:00</LastInteractionDate>
            <LastUpdated>2015-12-18T14:51:33.12</LastUpdated>
            <Notes>This is a note</Notes>
            <UserID>12345</UserID>
            <UserName>Freddy</UserName>
        </HotListMember>        
    </HotListMembers>
</HotList>