Profile Details

Use this method to return a specific AdultWork.com member's profile. You can specify what data gets returned.

URL / Endpoint

GET/POST /v1/profile/getProfileDetails

Request

Property	Type	Description
`UserID`	integer	The User ID of the AdultWork.com member profile you wish the API to return. Required if `Nickname` is null.
`Nickname`	string	The Nickname of the AdultWork.com member profile you wish the API to return. Required if `UserID` is null.
`ReturnProfile`	boolean	If set to `true`, general Profile data such as Summary, Availability, Ratings and Location are returned. Default is `false`.
`ReturnDetails`	boolean	If set to `true`, the Profile Details field is returned. Default is `false`.
`ReturnEnjoys`	boolean	If set to `true`, the member's Preferences / Enjoys list is returned (if they have been set). Default is `false`.
`ReturnEscortRates`	boolean	If set to `true`, the member's Escort Rates are returned (if they have been set). Default is `false`.
`ReturnContact`	boolean	If set to `true`, the member's Contact information will be returned. Default is `false`.
`ReturnFAQs`	boolean	If set to `true`, the member's Frequently Asked Questions are returned (if they have created any). Default is `false`.
`ReturnImages`	boolean	If set to `true`, the member's Profile Images are returned (if they have uploaded any). Members can have upto 3 images. Default is `false`.
`ReturnInterview`	boolean	If set to `true`, the member's AdultWork.com Interview is returned (if they have participated). Default is `false`.
`Roles`	bitmask integer	Filters the returned interview questions based on the roles specified for the question. For example, providing `1` as value will only return questions relevant for Escorts. Only relevant if `ReturnInterview` equals true IsEscort = 1IsWebcam = 2IsPhoneChat = 4IsSMSChat = 8IsAlternative = 16IsSupplier = 32IsContent = 64
`ReturnLinks`	boolean	If set to `true`, the member's custom links are returned (if they have created any).
`ReturnVitalStats`	boolean	If set to `true`, the member's Vital Statistics are returned (if they have answered these questions in the AdultWork.com Interview). Default is `false`.
`ReturnCountry`	boolean	If set to `true`, the member's country information is returned. Default is `false`.
`ReturnNationality`	boolean	If set to `true`, the member's nationality information is returned. Default is `false`.
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.
`IPv4Address`	IP Address	Provide the IP Address of your application user. When not supplying the application user's IP Address, some profiles could not be displayed properly or even not at all. *Note:* This is only needed when making server side calls. All client-side calls handle this automatically.
`ReturnMotD`	boolean	If set to `true`, the member's Member of the Day status for the various properties (eg EscortOfTheDay) is returned. Default is `false`.
`ReturnContentCounts`	boolean	If set to `true`, the member's contents count (free galleries etc) is returned. Default is `false`.
`ReturnFeatured`	boolean	If set to `true`, the member's featured details are returned. Default is `false`.
`ReturnLoggedInNow`	boolean	If set to `true`, the member's logged in status is returned. Default is `false`.
`ReturnAlternativePractices`	boolean	If set to `true`, the member's alternative practices are returned. Default is `false`.
`ReturnOtherServices`	boolean	If set to `true`, the member's service categories are returned. Default is `false`.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body, or 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

Your API-Key is required with every request and can be passed in as a header or a query-string parameter. Don't have an API-Key? Get one now.

Samples

GET method

https://api-sandbox.adultwork.com/v1/profile/getProfileDetails
  ?apiKey={your-api-key}
  &UserID=123456
  &ReturnProfile=true
  &ReturnContact=true
  &ReturnLinks=true

POST https://api-sandbox.adultwork.com/v1/profile/GetProfileDetails HTTP/1.1
Host: api-sandbox.adultwork.com
Content-Length: 77
Accepts: application/json
Content-Type: application/json
X-ApiKey: {your-api-key}
{"UserID":123456, "ReturnProfile":true, "ReturnContact":true, "ReturnLinks":true}

curl -v https://api-sandbox.adultwork.com/v1/profile/getProfileDetails \
-H "Content-Type:application/json" \
-H "X-ApiKey: {your-api-key}" \
-d '{
  "UserID":123456,
  "ReturnProfile":true,
  "ReturnContact":true,
  "ReturnLinks":true
}'

Response

Property	Type	Description
`HasProfile`	boolean	If set to `true`, `Profile` data will be included in the response.
`Profile`	aws:UserProfileDetails	The member's profile data, such as Summary and Location information.
`HasDetails`	boolean	If set to `true`, `Details` text for the profile will be included in the response. BBCode and tabs are formatted by default but can be set to return raw in the settings for the API Project.
`Details`	string	The member's Profile Details. This text may be split into tabs.
`HasImages`	boolean	If set to `true`, `Images` data will be included in the response.
`Images`	aws:ProfileImages	The member's profile images in varying sizes with full file locations.
`HasContact`	boolean	If set to `true`, `Contact` data will be included in the response.
`Contact`	aws:ProfileContact	The member's contact information, such as telephone number and email address.
`HasVitalStats`	boolean	If set to `true`, `VitalStats` data will be included in the response.
`VitalStats`	aws:ProfileVitalStats	The member's Vital Statistics. These are selected questions from the AdultWork.com Interview.
`HasEnjoys`	boolean	If set to `true`, `Enjoys` data will be included in the response.
`Enjoys`	Array of aws:ProfileEnjoy	List of the member's Preferences / Enjoys selections.
`HasEnjoysWith`	boolean	If set to `true`, `EnjoysWith` data will be included in the response.
`EnjoysWith`	Array of aws:ProfileEnjoyWith	List of the Preferred Genders the member has selected.
`HasEscortRates`	boolean	If set to `true`, `EscortRates` data will be included in the response.
`EscortRates`	aws:ProfileEscortRates	The members Escort Rates and preffered currency.
`HasFAQs`	boolean	If set to `true`, `FAQs` data will be included in the response.
`FAQs`	Array of aws:ProfileFAQ	List of the Frequently Asked Questions the member has created.
`HasInterview`	boolean	If set to `true`, `Interview` data will be included in the response.
`Interview`	aws:ProfileInterview	The member's AdultWork.com Interview questions and answers.
`HasCountry`	boolean	If set to `true`, `Country` data will be included in the response.
`Country`	aws:Country	The member's AdultWork.com country.
`HasNationality`	boolean	If set to `true`, `Nationality` data will be included in the response if the member supplied the information.
`Nationality`	aws:Country	The member's AdultWork.com nationality. Note: This will be returned if the member has supplied the information.
`HasLinks`	boolean	If `true`, the member's custom links are included in the response.
`Links`	Array of aws:ProfileLink	The member's custom links from their profile.
`HasFeatured`	boolean	If `true`, the member's 'featured' statuses are included in the response.
`Featured`	aws:ProfileFeatured	The member's 'featured' status for the various properties for the current day.
`HasReturnMotD`	boolean	If `true`, the member's 'Member of the Day' statuses are included in the response.
`ReturnMotD`	aws:ReturnMotD	The member's '...of the day' status for the various properties.
`HasContentCounts`	boolean	If `true`, the member's content counts are included in the response.
`ContentCounts`	aws:ContentCounts	The number of items specified for the member.
`IsLoggedInNow`	boolean	If `true`, the member is currently logged in, otherwise `false`.
`HasPractices`	boolean	If `true`, the member's alternative practices are included in the response.
`Practices`	aws:ProfileAlternativePractice	An array of alternative practice of the member.
`HasOtherServices`	boolean	If `true`, the member's other service categories are included in the response.
`Categories`	aws:ProfileCategory	An array of service categories of the member.

Response Sample

The following example returns a profile with ReturnProfile, ReturnContact, ReturnLinks, ReturnCountryand ReturnNationality set to true.

JSON
XML

{
    "HasProfile":true,
    "Profile":{
        "UserID":123456,
        "Nickname":"JosepheneBlogs",
        "Summary":"Hey guys - check out my profile!",
        "Gender":"Female",
        "Age":21,
        "Orientation":"Bi-curious",
        "Country":"United Kingdom",
        "Region":"South East",
        "County":"London",
        "Town":"Westminster",
        "LocationZipCode":"KT14",
        "Nationality": "British",
        "Views":28837,
        "MemberSince":"2013-08-09T10:15:37.517",
        "LastLoggedIn":"2014-06-20T09:11:20.053",
        "Verified":false,
        "IsEscort":true,
        "IsWebcam":false,
        "IsPhoneChat":false,
        "IsSMSChat":false,
        "IsAlternative":false,
        "IsDirectCam":false,
        "IsDirectChat":false,
        "AvailableTodayEscort":false,
        "AvailableNowWebcam":false,
        "AvailableNowPhoneChat":false,
        "DirectCam":{
            "ModeID": null,
            "Mode": "",
            "ModeColour": null,
            "ChatOnly": false,
            "DoesFreePreview": false,
            "DoesFreeToGuest": false,
            "DoesGroup": true,
            "GroupPPM": "2.50",
            "DoesPrivate": true,
            "PrivatePPM": "3.50",
            "DirectCamLink": "https://www.adultwork.com/Player6.0/PlayerLauncher.asp?U=123456",
            "AllowVoyeur": false,
            "TipsOnly": false,
            "HasSpecialOffers": false,
            "HasShows": true
        },
        "DirectChat":{
            "PPM":"1.20"
        },
        "HasGallery":true,
        "HasPrivateGallery":true,
        "HasMovieClips":false,
        "HasMovieRentals":false,
        "HasSaleItems":false,
        "Ratings":{
            "Total":1001,
            "Positive":1001,
            "Neutral":0,
            "Negative":0,
            "Ratings":0,
            "Disputes":0
        },
        "IsCouple": false,
        "InGroup":true,
        "GroupName":"My AdultWork Group",
        "ProfileURL": "http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2f123456",
        "RatingsURL": "http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2fdlgExtRatings.asp%3fU%3d123456",
        "HasBlog": true,
        "LastUpdated": "2015-12-23T10:16:53.447",
        "IsBlacklisted": null,
        "IsOnTour": false,
        "ContentOverview": {
            "FreeGalleryCount": 0,
            "FreeGalleryLatestThumbSafe": false,
            "FreeGalleryLatestThumbURL": null,
            "PrivateGalleryCount": 0,
            "PrivateGalleryLatestThumbSafe": false,
            "PrivateGalleryLatestThumbURL": null,
            "MovieClipCount": 0,
            "MobileClipCount": 0,
            "MovieClipLatestThumbSafe": false,
            "MovieClipLatestThumbURL": null,
            "RentalMovieCount": 0,
            "RentalMovieLatestThumbSafe": false,
            "RentalMovieLatestThumbURL": null
        }
    },
    "HasDetails":false,
    "Details":null,
    "HasImages":false,
    "Images":null,
    "HasContact":true,
    "Contact":{
        "HasEmailAddress":false,
        "EmailAddress":null,
        "HasMobileNumber":false,
        "MobileNumber":null,
        "HasPhoneChatNumber":false,
        "PhoneChatNumber":null,
        "HasGroupPhoneNumber":false,
        "GroupPhoneNumber":null,
        "VoiceMailSteps":"",
        "VoiceMailPrice":"",
        "HasApps": true,
        "Apps": [
            {
                "Name": "Facebook",
                "DownloadURL": null,
                "IconUrl": "https://cdn1.adultwork.com/Images/AppIcons/Facebook.png",
                "Nickname": "facebook",
                "UseForValidWCBookings": true,
                "UseForValidPCBookings": false,
                "UseForValidTCBookings": false
            }
        ]
    },
    "HasVitalStats":false,
    "VitalStats":null,
    "HasEnjoys":false,
    "Enjoys":null,
    "HasEnjoysWith":false,
    "EnjoysWith":null,
    "HasEscortRates":false,
    "EscortRates":null,
    "HasFAQs":false,
    "FAQs":null,
    "HasInterview":false,
    "Interview":null,
    "HasCountry": true,
    "Country": {
    "CountryID": 158,
    "CountryName": "United Kingdom",
    "CountryISO2": "UK",
    "CountryISO3": "GBR",
    "Nationality": "British"
    },
    "HasNationality": true, 
    "Nationality": {
    "CountryID": 158,
    "CountryName": "United Kingdom",
    "CountryISO2": "UK",
    "CountryISO3": "GBR",
    "Nationality": "British"
     },  
    "HasLinks":true,
    "Links": {
        "ID": 1,
        "Text": "My other site",
        "URL": "www.jb.name"
    },
    "HasOtherServices": true,
    "Categories": [
        {
            "CategoryId": 3,
            "CategoryName": "Drivers"
        }
    ],
    "HasPractices": true,
    "Practices": [
        {
            "PracticeId": 1,
            "PracticeName": "Bondage & Discipline"
        }
    ]
}

<ProfileDetailsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">
    <HasProfile>true</HasProfile>
    <Profile>
        <UserID>123456</UserID>
        <NickName>JosepheneBlogs</NickName>
        <Summary>Hey guys - check out my profile!</Summary>
        <Gender>Female</Gender>
        <Age>21</Age>
        <Orientation>Bi-curious</Orientation>
        <Country>United Kingdom</Country>
        <Region>South East</Region>
        <County>London</County>
        <Town>Westminster</Town>
        <LocationZipCode>KT14</LocationZipCode>
        <Nationality>British</Nationality>
        <Views>28837</Views>
        <MemberSince>2013-08-09T10:15:37.517</MemberSince>
        <LastLoggedIn>2014-06-20T09:11:20.053</LastLoggedIn>
        <Verified>false</Verified>
        <IsEscort>true</IsEscort>
        <IsWebcam>false</IsWebcam>
        <IsPhoneChat>false</IsPhoneChat>
        <IsSMSChat>false</IsSMSChat>
        <IsAlternative>false</IsAlternative>
        <IsBlacklisted i:nil="true" />
        <IsOnTour>false</IsOnTour>
        <IsDirectCam>false</IsDirectCam>
        <IsDirectChat>false</IsDirectChat>
        <AvailableTodayEscort>false</AvailableTodayEscort>
        <AvailableNowWebcam>false</AvailableNowWebcam>
        <AvailableNowPhoneChat>false</AvailableNowPhoneChat>
        <DirectCam xmlns:d4p1="http://schemas.datacontract.org/2004/07/API.Models.Profile">
            <d4p1:AllowVoyeur>false</d4p1:AllowVoyeur>
            <d4p1:ChatOnly>false</d4p1:ChatOnly>
            <d4p1:DirectCamLink>https://www.adultwork.com/Player6.0/PlayerLauncher.asp?U=197704</d4p1:DirectCamLink>
            <d4p1:DoesFreePreview>false</d4p1:DoesFreePreview>
            <d4p1:DoesFreeToGuest>false</d4p1:DoesFreeToGuest>
            <d4p1:DoesGroup>true</d4p1:DoesGroup>
            <d4p1:DoesPrivate>true</d4p1:DoesPrivate>
            <d4p1:GroupPPM>2.50</d4p1:GroupPPM>
            <d4p1:HasSpecialOffers>false</d4p1:HasSpecialOffers>
            <d4p1:Mode></d4p1:Mode>
            <d4p1:ModeColour i:nil="true" />
            <d4p1:ModeID i:nil="true" />
            <d4p1:PrivatePPM>3.50</d4p1:PrivatePPM>
            <d4p1:TipsOnly>false</d4p1:TipsOnly>
            <d4p1:HasShows>false</d4p1:HasShows>
        </DirectCam>
        <DirectChat>
            <PPM>1.20</PPM>
        </DirectChat>
        <HasGallery>true</HasGallery>
        <HasPrivateGallery>true</HasPrivateGallery>
        <HasMovieClips>false</HasMovieClips>
        <HasMovieRentals>false</HasMovieRentals>
        <HasSaleItems>false</HasSaleItems>
        <Ratings>
            <Total>1001</Total>
            <Positive>1001</Positive>
            <Neutral>0</Neutral>
            <Negative>0</Negative>
            <Ratings>0</Ratings>
            <Disputes>0</Disputes>
        </Ratings>
        <IsCouple>true</IsCouple>
        <InGroup>true</InGroup>
        <GroupName>My AdultWork Group</GroupName>
        <ProfileURL>http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2f123456</ProfileURL>
        <RatingsURL>http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2fdlgExtRatings.asp%3fU%3d123456</RatingsURL>
        <HasBlog>true</HasBlog>
        <LastUpdated>
            2015-12-23T10:16:53.447
        </LastUpdated>
        <ContentOverview>
            <FreeGalleryCount>0</FreeGalleryCount>
            <FreeGalleryLatestThumbSafe>false</FreeGalleryLatestThumbSafe>
            <FreeGalleryLatestThumbURL i:nil="true" />
            <MobileClipCount>0</MobileClipCount>
            <MovieClipCount>0</MovieClipCount>
            <MovieClipLatestThumbSafe>false</MovieClipLatestThumbSafe>
            <MovieClipLatestThumbURL i:nil="true" />
            <PrivateGalleryCount>0</PrivateGalleryCount>
            <PrivateGalleryLatestThumbSafe>false</PrivateGalleryLatestThumbSafe>
            <PrivateGalleryLatestThumbURL i:nil="true" />
            <RentalMovieCount>0</RentalMovieCount>
            <RentalMovieLatestThumbSafe>false</RentalMovieLatestThumbSafe>
            <RentalMovieLatestThumbURL i:nil="true" />
        </ContentOverview>
    </Profile>
    <HasDetails>false</HasDetails>
    <Details />
    <HasImages>false</HasImages>
    <Images />
    <HasContact>true</HasContact>
    <Contact>
        <InternalEmailURL></InternalEmailURL>
        <HasEmailAddress>false</HasEmailAddress>
        <EmailAddress />
        <HasMobileNumber>false</HasMobileNumber>
        <MobileNumber />
        <HasPhoneChatNumber>false</HasPhoneChatNumber>
        <PhoneChatNumber />
        <HasGroupPhoneNumber>false</HasGroupPhoneNumber>
        <GroupPhoneNumber />
        <VoiceMailSteps></VoiceMailSteps>
        <VoiceMailPrice></VoiceMailPrice>
        <HasApps>true</HasApps>
        <Apps>
            <ProfileApp>
                <DownloadURL i:nil="true" />
                <IconURL>https://cdn1.adultwork.com/Images/AppIcons/Facebook.png</IconURL>
                <Name>Facebook</Name>
                <Nickname>facebook</Nickname>
                <UseForValidPCBookings>true</UseForValidPCBookings>
                <UseForValidTCBookings>false</UseForValidTCBookings>
                <UseForValidWCBookings>false</UseForValidWCBookings>
            </ProfileApp>
        </Apps>
    </Contact>
    <HasVitalStats>false</HasVitalStats>
    <VitalStats />
    <HasEnjoys>false</HasEnjoys>
    <Enjoys />
    <HasEnjoysWith>false</HasEnjoysWith>
    <EnjoysWith />
    <HasEscortRates>false</HasEscortRates>
    <EscortRates />
    <HasFAQs>false</HasFAQs>
    <FAQs />
    <HasInterview>false</HasInterview>
    <Interview />
    <HasCountry>true</HasCountry>
    <Country>
        <CountryID>158</CountryID>
        <CountryName>United Kingdom</CountryName>
        <CountryISO2>UK</CountryISO2>
        <CountryISO3>GBR</CountryISO3>
        <Nationality>British</Nationality>
    </Country>
    <HasNationality>true</HasNationality>
    <Nationality>
        <CountryID>158</CountryID>
        <CountryName>United Kingdom</CountryName>
        <CountryISO2>UK</CountryISO2>
        <CountryISO3>GBR</CountryISO3>
        <Nationality>British</Nationality>
    </Nationality>
    <HasLinks>true</HasLinks>
    <Links>
        <ProfileLink>
            <ID>1</ID>
            <Text>My other site</Text>
            <URL>www.jb.name</URL>
        </ProfileLink>
    </Links>
    <HasPractices>false</HasPractices>
    <Practices>
        <ProfileAlternativePractice>
            <PracticeID>1</PracticeID>
            <PracticeName>Bondage & Discipline</PracticeName>
        </ProfileAlternativePractice>
        <ProfileAlternativePractice>
            <PracticeID>6</PracticeID>
            <PracticeName>Other Alternative</PracticeName>
        </ProfileAlternativePractice>
    </Practices>
    <HasOtherServices>false</HasOtherServices>
    <Categories>
        <ProfileCategory>
            <CategoryID>3</CategoryID>
            <CategoryName>Drivers</CategoryName>
        </ProfileCategory>
    </Categories>