Get HotLists

This API operation returns a user's hotlists

URL / Endpoint

GET /v1/HotLists/GetHotLists

Request

Property	Type	Description
`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/GetHotLists

Authorization: bearer {your-access-token}

Response

Property	Type	Description
	Array of aws:HotList	An array of hotlists created by an AdultWork member.

Response Sample

The following shows a sample list of hotlists returned by the API.

JSON
XML

[
  {
    "HotListDetails": {
      "UserID": 1235453,
      "ListID": 111,
      "ListName": "AW Greatest",
      "UserName": "Joey69"
    },
    "HotListMembers": [
      {
        "UserID": 1234,
        "InteractionCount": 0,
        "UserName": "Jane",
        "Notes": null,
        "LastUpdated": "2016-04-06T10:35:12.793",
        "LastInteractionDate": "0001-01-01T00:00:00",
        "Profile": null
      },
      {
        "UserID": 12345,
        "InteractionCount": 0,
        "UserName": "Freddy",
        "Notes": "Seems to like me too",
        "LastUpdated": "2016-04-06T10:35:12.793",
        "LastInteractionDate": "0001-01-01T00:00:00",
        "Profile": null
      }
    ]
  },
  {
    "HotListDetails": {
      "UserID": 1235453,
      "ListID": 112,
      "ListName": "Best cammers",
      "UserName": "Joey69"
    },
    "HotListMembers": [
      {
        "UserID": 123456,
        "InteractionCount": 0,
        "UserName": "Nikki",
        "Notes": null,
        "LastUpdated": "2016-04-06T12:30:31.38",
        "LastInteractionDate": "0001-01-01T00:00:00",
        "Profile": null
      },
      {
        "UserID": 1234567,
        "InteractionCount": 0,
        "UserName": "Trudy",
        "Notes": "I like Trudy",
        "LastUpdated": "2016-04-06T12:30:31.38",
        "LastInteractionDate": "0001-01-01T00:00:00",
        "Profile": null
      },
      {
        "UserID": 112233,
        "InteractionCount": 0,
        "UserName": "SmartSammy",
        "Notes": "Lovely solo show",
        "LastUpdated": "2016-04-06T12:30:31.38",
        "LastInteractionDate": "0001-01-01T00:00:00",
        "Profile": null
      }
    ]
  }
]

<ArrayOfHotList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.HotLists">
    <HotList>
        <HotListDetails>
            <ListID>111</ListID>
            <ListName>AW Greatest</ListName>
            <UserID>111222</UserID>
            <UserName>Joey69</UserName>
        </HotListDetails>
        <HotListMembers>
            <HotListMember>
                <InteractionCount>0</InteractionCount>
                <LastInteractionDate>0001-01-01T00:00:00</LastInteractionDate>
                <LastUpdated>2016-04-06T10:35:12.793</LastUpdated>
                <Notes i:nil="true" />
                <UserID>12345</UserID>
                <UserName>Jane</UserName>
            </HotListMember>
            <HotListMember>
                <InteractionCount>0</InteractionCount>
                <LastInteractionDate>0001-01-01T00:00:00</LastInteractionDate>
                <LastUpdated>2016-04-06T10:35:12.793</LastUpdated>
                <Notes i:nil="true" />
                <UserID>123456</UserID>
                <UserName>Freddy</UserName>
            </HotListMember>
        </HotListMembers>
    </HotList>
    <HotList>
        <HotListDetails>
            <ListID>112</ListID>
            <ListName>Best cammers</ListName>
            <UserID>111222</UserID>
            <UserName>Joey69</UserName>
        </HotListDetails>
        <HotListMembers>
            <HotListMember>
                <InteractionCount>0</InteractionCount>
                <LastInteractionDate>0001-01-01T00:00:00</LastInteractionDate>
                <LastUpdated>2016-04-06T12:30:31.38</LastUpdated>
                <Notes i:nil="true" />
                <UserID>112233</UserID>
                <UserName>Trudy</UserName>
            </HotListMember>
            <HotListMember>
                <InteractionCount>0</InteractionCount>
                <LastInteractionDate>0001-01-01T00:00:00</LastInteractionDate>
                <LastUpdated>2016-04-06T12:30:31.38</LastUpdated>
                <Notes i:nil="true" />
                <UserID>12345657</UserID>
                <UserName>Nikki</UserName>
            </HotListMember>
            <HotListMember>
                <InteractionCount>0</InteractionCount>
                <LastInteractionDate>0001-01-01T00:00:00</LastInteractionDate>
                <LastUpdated>2016-04-06T12:30:31.38</LastUpdated>
                <Notes i:nil="true" />
                <UserID>124456</UserID>
                <UserName>SmartSammy</UserName>
            </HotListMember>
        </HotListMembers>
    </HotList>
</ArrayOfHotList>