Search Profiles

Use this API operation to return a list of AdultWork.com member profiles on the criteria you pass in.

URL / Endpoint

GET/POST /v1/Search/SearchProfiles

Request

Property	Type	Description
`ProfilesPerPage`	integer	Sets the number of profiles on each page of the result set. Accepts values from `1` to `100`. Default is `50`.
`PageNumber`	integer	Returns a specific page in the result set. Accepts values from `1` onwards.
`OrderBy`	string	Sets the order in which the profiles will be returned. Default is Last Updated date. Order options are `rating`, `ratingtotal`, `registerdate`, `views`, `inrates-asc`,`inrates-desc`, `outrates-asc`,`outrates-desc`, `age-asc`,`age-desc`, `nickname-asc`, `nickname-desc`, `lastupdated` and `locationproximity`. Please note when using `locationproximity` you will have to supply `LocationZipCode`
`UserIDs`	string of comma-seperated integers	Returns profiles whose UserID is within this list. This is useful if you need to search within a known selection of users. Accepts a comma delimited string of User IDs, for example: `123,124,125,126`.
`IsEscort`	boolean	If set to `true`, profiles returned will offer Escort services. Default is `false`.
`IsWebcam`	boolean	If set to `true` profiles returned will offer Webcam services. Default is `false`.
`IsPhoneChat`	boolean	If set to `true` profiles returned will offer Phone Chat services. Default is `false`.
`IsSMSChat`	boolean	If set to `true` profiles returned will offer SMS Text Chat services. Default is `false`.
`IsAlternative`	boolean	If set to `true` profiles returned will offer Alternative Escort services. Default is `false`.
`IsOtherServices`	boolean	If set to `true` profiles returned will offer other services. Default is `false`.
`IsDirectCam`	boolean	If set to `true` profiles returned will offer DirectCam services. Default is `false`. `IsWebcam` will be set automatically.
`IsDirectCamOnly`	boolean	If set to `true` profiles returned will offer DirectCam services but have disabled the option to be pre-booked for webcam sessions. `IsWebcam` and `IsDirectCam` will be set automatically.
`IsDirectChat`	boolean	If set to `true` profiles returned will offer DirectChat services. Default is `false`. `IsPhoneChat` will be set automatically.
`IsDirectChatOnly`	boolean	If set to `true` profiles returned will offer DirectChat services but have disabled the option to be pre-booked for phone chat sessions. `IsPhoneChat` and `IsDirectChat` will be set automatically.
`IsVerified`	boolean	If set to `true` profiles returned will be fully verified.
`IsAvailableTodayEscort`	boolean	If set to `true` profiles returned will offer Escort services and will be Available Today. Default is `false`. `IsEscort` will be set automatically.
`IsAvailableNowWebcam`	boolean	If set to `true` profiles returned will offer Webcam services and will be Available Now. Default is `false`. `IsWebcam` will be set automatically.
`IsANWCOrDcaOnline`	boolean	If set to `true` profiles returned will offer Webcam bookings and will be Available Now OR currently be logged in to JustCamIt. Default is `false`.
`IsAvailableNowPhoneChat`	boolean	If set to `true` profiles returned will offer Phone Chat services and will be Available Now. Default is `false`. `IsPhoneChat` will be set automatically.
`DirectCamInGroup`	boolean	If set to `true` profiles returned will offer DirectCam services and will be available for Group Chat. Default is `false`. `IsWebcam` and `IsDirectCam` will be set automatically.
`DirectCamFreePreview`	boolean	If set to `true` profiles returned will offer DirectCam services and will be available for Free Preview. Default is `false`. `IsWebcam` and `IsDirectCam` will be set automatically.
`DirectCamCategoryID`	integer	Returns profiles from the DirectCam category to which `DirectCamCategoryID` relates. `IsWebcam` and `IsDirectCam` will be set automatically.
`HasGallery`	boolean	If set to `true` profiles returned will have a Free Gallery of images. Default is `false`.
`HasPrivateGallery`	boolean	If set to `true` profiles returned will have a Private Gallery of images available for subscription. Default is `false`.
`HasMovieClips`	boolean	If set to `true` profiles returned will have a Movie Clip library. Default is `false`.
`HasMovieRentals`	boolean	If set to `true` profiles returned will have a Rental Movie collection. Default is `false`.
`HasSaleItems`	boolean	If set to `true` profiles returned will offer items for Sale or Auction. Default is `false`.
`LocationProximityMiles`	integer	Distance in miles from Postcode/Zipcode. From `1` - `99`. `LocationZipCode` required.
`LocationProximityKilometres`	integer	Distance in kilometres from Postcode/Zipcode. From `1` - `159`. `LocationZipCode` required. If a value is also set in `LocationProximityMiles` that property will take presidence.
`LocationZipCode`	string	Returns profiles within a specified number of miles (or kilometres) from the Postcode/Zipcode supplied. `LocationProximityMiles` or `LocationProximityKilometres` required.
`CountryID`	integer	Returns profiles from the Country to which `CountyID` relates. See the getCountries method.
`RegionID`	integer	Returns profiles from the Region to which `RegionID` relates. See the getRegions method.
`CountyID`	integer	Returns profiles from the County to which `CountyID` relates. See the getCounties method.
`NationalityID`	integer	Returns profiles from the Nationality to which `NationalityID` relates. See the getCountries method.
`RatingsNotHidden`	boolean	If set to `true` profiles returned will not have their Ratings hidden. Default is `false`.
`RatingsPositive`	boolean	If set to `true` profiles returned will have a positive Rating Total. Default is `false`.
`PreferenceIDs`	string of comma-seperated integers	Returns profiles that match Enjoys / Preferences that relate to a Preference IDs within `PreferenceIDs`. Accepts a comma delimited string of Enjoy IDs, for example: `2,5,14,21`. See the getEnjoys method.
`GenderIDs`	string of comma-seperated integers	Returns profiles that have selected their Gender to one that relates to a Gender ID within `GenderIDs`. Accepts a comma delimited string of Gender IDs, for example: `1,2`. See the getGenders method.
`GenderWithIDs`	string of comma-seperated integers	Returns profiles that have selected Preferred Genders to which Gender IDs within `GenderWithIDs` relate. Accepts a comma delimited string of Gender IDs, for example: `3,4`. See the getGenders method.
`OrientationIds`	string of comma-seperated integers	Returns profiles that have selected their Orientation to one that relates to a Orientation ID within `OrientationIDs`. Accepts a comma delimited string of Orientation IDs, for example: `1,2`. See the getOrientations method.
`NonExplicitSelfCertified`	boolean	If set to `true`, profiles returned will be self-certified (by the member) to be non-explicit.
`GroupID`	integer	Returns profiles which are member of a group with the specified group ID.
`TVTS`	integer	Returns profiles that have checked the option TV/TS in their profile details. Accepts: `0` to exclude TV/TS profiles, `1` to include TV/TS profiles and `2` to show only tvts profiles.
`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.
`LastUpdated`	datetime	If supplied it will get only the profiles that where updated on this date. Format: yyyy-mm-dd
`LastUpdatedFrom`	datetime	If supplied it will get only the profiles that where updated from this date. Format: yyyy-mm-dd
`PracticeIDs`	string of comma-seperated integers	Returns profiles that match practices that relate to Practice IDs within `PracticeIDs`. Accepts a comma delimited string of Practice IDs, for example: `1,2,3,4`. See the getAlternativePractices method.
`CategoryIDs`	string of comma-seperated integers	Returns profiles that match Other services categories that relate to Category IDs within `CategoryIDs`. Accepts a comma delimited string of Category IDs, for example: `2,4,7,9`. See the getOtherServices method.
`HasRoles`	integer	The bitmask representing the following selection of roles: IsEscort = 1, IsWebcam = 2, IsPhoneChat = 4, IsSMSChat = 8, IsAlternative = 16, IsOtherServices = 32 E.g. pass HasRoles=3 (1+2) to retrieve all users with IsEscort or IsWebcam
`Questions`	string	Returns profiles that have completed the AdultWork Interview with answers you've chosen. Accepts the following format: `ID1[Answer1,Answer2],ID2[Answer1]`. For example: `1[Aquarius Jan 20 - Feb 18],4[Smile]`. See the getQuestions method.
`QuestionsBehaviour`	string	Modify the search behaviour to include profiles that have any specified Questions answered, or all. Accepts the following format: `and`,`or`. For example: `or` will include all profiles that have any of the provided answers in the `Questions` parameter answered.
`ExcludeBlacklistedUsers`	boolean	Returns profiles that have been marked as blacklisted by the user who you are calling on behalf of using the OAuth token.The required scope is `profile_blacklist`. Possible values are `true` to exclude the profiles that have been blacklisted, `false` to include the blacklisted profiles. Don't supply it when you don't want to include or exclude the blacklisted users. *Note:* This is only available when using the OAuth token.
`IsLocalEscort`	boolean	Returns profiles that are listed in the Featured Local Escorts section. This works in conjunction with `CountryID` (required), `RegionID` (required) and `CountyID`.
`MinAge`	integer	Returns profiles of users profiles that have a minimum age (in years) of the supplied value, calculated from their supplied Date of Birth. All members are 18+ years of age.
`MaxAge`	integer	Returns profiles of users that have a maximum age (in years) of the supplied value, calculated from their supplied Date of Birth. All members are 18+ years of age.
`InGroup`	boolean	Returns profiles that are a member of a group when set to `true`. When set to `false` this endpoint will return profiles that are not a member of a group.
`Town`	string	Returns profiles that have set their town and it matches (part of) the value. Maximum length is `50`.
`Nickname`	string	Returns profiles that have the characters supplied in their nickname. Maximum length is `20`.
`HasPhoneNumber`	boolean	Returns profiles that have opted to display their phone number. Possible values are `true` to only return the profiles that have opted to display their phone number, `false` to exclude those profiles. *Note:* This is only available when using the OAuth token and when the seeking user is subscribed to the AdultWork.com's Telephone Directory. When no OAuth token is used or the logged in user using OAuth is not subscribed to the AdultWork.com's Telephone Directory this will be ignored.
`ReturnContentOverview`	boolean	If this is true, the response will contain the `ContentOverview` for each of the returned profile. Default is false.
`ReturnEscortRates`	boolean	If this is true, the response will contain the `EscortRates` for each of the returned profile. Default is false. If `InRates` or `OutRates` is provided, this will automatically be set to true.
`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.
`DoesInCalls`	boolean	If this is true, the response will contain only profiles that are Escorts, and have set up in-calls in their profile.
`DoesOutCalls`	boolean	If this is true, the response will contain only profiles that are Escorts, and have set up out-calls in their profile.
`InRates`	aws: Search- Escort- Rates	Providing this property allows you to search for specific Incall Escort Rates, with minimum or maximum values, and optionally with a specific currency only.
`OutRates`	aws: Search- Escort- Rates	Providing this property allows you to search for specific Outcall Escort Rates, with minimum or maximum values, and optionally with a specific currency only.

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.

An Authorization header is optional with every request and must contain the access_token of the user. To use the parameter 'ExcludeBlacklistedUsers' this is required. When using the Authorization header with a valid access_token do not use the API-Key.

Scopes

This endpoint does not require any scopes but when using the input parameter 'ExcludeBlacklistedUsers' it does. When setting this to 'true' the scope profile_blacklist will be required. Please read our Access tokens page for more information.

ExcludeBlacklistedUsers	Scope
true	`profile_blacklist`

Samples

GET method

https://api-sandbox.adultwork.com/v1/search/searchProfiles
  ?apiKey={your-api-key}
  &IsEscort=true
  &IsWebcam=true
  &GenderIDs=1
  &PreferenceIDs=1,34,45

POST http://api-adultwork.com/v1/search/searchProfiles HTTP/1.1
Host: api-sandbox.adultwork.com
Content-Length: 77
Content-Type: application/json
X-ApiKey: {your-api-key}

{"IsEscort":true, "IsWebcam":true, "GenderIDs":"1","PreferenceIDs":"1,34,45"}

curl -v https://api-sandbox.adultwork.com/v1/search/searchProfiles \
-H "Content-Type:application/json" \
-H "X-ApiKey: {your-api-key}" \
-d '{
  "IsEscort":true,
  "IsWebcam":true,
  "GenderIDs":"1",
  "PreferenceIDs":"1,34,45"
}'

Response

Property	Type	Description
`PageCount`	integer	Represents the total number of pages in the result set.
`PageNumber`	integer	Represents the current page number.
`ProfilesTotal`	integer	Represents the total number of profiles in the result set.
`ProfilesPerPage`	integer	Represents how many profiles are listed on each page.
`Profiles`	Array of aws:UserProfileResult	List of profile data.

Response Sample

The following example returns a single profile.

JSON
XML

{
    "PageNumber":1,
    "PageCount":1,
    "ProfilesPerPage":50,
    "ProfilesTotal":1,
    "Profiles":[
        {
            "LocationProximityMiles":0,
            "LocationProximityKilometres":0,
            "HasProfileThumbnail":false,
            "ProfileThumbnailSafe": false,
            "ProfileThumbnailURL":null,
            "ProfileSquareSafe": false,
            "ProfileSquareURL":null,
            "UserID":123456,
            "NickName":"JosepheneBlogs",
            "Summary":"Hey guys - check out my profile!",
            "Gender":"Female",
            "Age":21,
            "Orientation":"Straight",
            "Country":"United Kingdom",
            "Region":"London",
            "County":"Ealing",
            "Town":"London",
            "NationalityID":"158",
            "Nationality":"British",
            "NationalityISO2":"UK",
            "Views":82046,
            "MemberSince":"2014-01-09T21:21:27.613",
            "LastLoggedIn":"2014-06-19T09:48:09.07",
            "Verified":true,
            "IsEscort":true,
            "DoesOutCalls": false,
            "DoesInCalls": true,
            "IsWebcam":false,
            "IsPhoneChat":false,
            "IsSMSChat":false,
            "IsAlternative":false,
            "IsOtherServices":false,
            "IsDirectCam":false,
            "IsDirectChat":false,
            "AvailableTodayEscort":true,
            "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.00"
            },
            "HasGallery":true,
            "HasPrivateGallery":true,
            "HasMovieClips":false,
            "HasMovieRentals":false,
            "HasSaleItems":false,
            "Ratings":{
                "Total":33,
                "Positive":34,
                "Neutral":0,
                "Negative":1,
                "Ratings":35,
                "Disputes":0
            },
            "IsCouple": false,
            "InGroup":true,
            "GroupName":null,
            "GroupID":1,
            "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": false,
            "LastUpdated": "2015-12-23T10:54:50.233",
            "IsBlacklisted": false,
            "IsOnTour": false,
            "HasPhoneNumber": false,
            "ContentOverview": null,
            "EscortRates": null
        }
    ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<PageNumber>1</PageNumber>
<PageCount>1</PageCount>
<ProfilesPerPage>50</ProfilesPerPage>
<ProfilesTotal>1</ProfilesTotal>
<Profiles>
    <LocationProximityMiles>0</LocationProximityMiles>
    <LocationProximityKilometres>0</LocationProximityKilometres>	
    <HasProfileThumbnail>false</HasProfileThumbnail>
    <ProfileThumbnailSafe>false</ProfileThumbnailSafe>
    <ProfileThumbnailURL i:isnil="true" />
    <ProfileSquareSafe>false</ProfileSquareSafe> 
    <ProfileSquareURL i:isnil="true" />
    <UserID>123456</UserID>
    <NickName>JosepheneBlogs</NickName>
    <Summary>Hey guys - check out my profile!</Summary>
    <Gender>Female</Gender>
    <Age>21</Age>
    <Orientation>Straight</Orientation>
    <Country>United Kingdom</Country>
    <ContentOverview i:nil="true" />
    <EscortRates i:nil="true" />
    <Region>London</Region>
    <County>Ealing</County>
    <Town>London</Town>
    <NationalityID>158</NationalityID>
    <Nationality>British</Nationality>
    <NationalityISO2>UK</NationalityISO2>	
    <Views>82046</Views>
    <MemberSince>2014-01-09T21:21:27.613</MemberSince>
    <LastLoggedIn>2014-06-19T09:48:09.07</LastLoggedIn>
    <Verified>true</Verified>
    <IsEscort>true</IsEscort>
    <DoesOutCalls>false</DoesOutCalls>
    <DoesInCalls>true</DoesInCalls>
    <IsWebcam>false</IsWebcam>
    <IsOnTour>false</IsOnTour>
    <HasPhoneNumber>false</HasPhoneNumber>
    <IsPhoneChat>false</IsPhoneChat>
    <IsSMSChat>false</IsSMSChat>
    <IsAlternative>false</IsAlternative>
    <IsOtherServices>false</IsOtherServices>
    <IsDirectCam>false</IsDirectCam>
    <IsDirectChat>false</IsDirectChat>
    <AvailableTodayEscort>true</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.00</PPM>
    </DirectChat>
    <HasGallery>true</HasGallery>
    <HasPrivateGallery>true</HasPrivateGallery>
    <HasMovieClips>false</HasMovieClips>
    <HasMovieRentals>false</HasMovieRentals>
    <HasSaleItems>false</HasSaleItems>
    <Ratings>
        <Total>33</Total>
        <Positive>34</Positive>
        <Neutral>0</Neutral>
        <Negative>1</Negative>
        <Ratings>35</Ratings>
        <Disputes>0</Disputes>
    </Ratings>
    <IsCouple>true</IsCouple>
	<InGroup>true</InGroup>
    <GroupName />
    <GroupID>1</GroupID>	
	<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:54:50.233</LastUpdated>
	<IsBlacklisted>false</IsBlacklisted>
</Profiles>