Search Groups

Use this API operation to return a list of Groups on the criteria you pass in.

URL / Endpoint

GET /v1/search/searchGroups

Request

Property	Type	Description
`PageSize`	integer	Sets the number of groups 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.
`GroupTypeIDs`	string	Returns profiles that have selected their GroupType to one that relates to a GroupType ID within `GroupTypeIDs`. Accepts a comma delimited string of GroupType IDs, for example: `1,2`. See the getGroupTypes method.
`GroupName`	string	Returns groups that containing in their name the string passed in.
`CountryID`	integer	Returns groups from the Country to which `CountryID` relates. See the getCountries method.
`RegionID`	integer	Returns groups from the Region to which `RegionID` relates. See the getRegions method.
`CountyID`	integer	Returns groups from the County to which `CountyID` relates. See the getCounties method.
`FeaturedOnly`	boolean	If set to `true`, search will return only featured groups. Criteria with the exclusion of `PageNumber` and `PageSize` will be ignored. Default is false

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

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/search/searchGroups
  ?apiKey={your-api-key}
  &GroupTypeIDs=1,2

Response

Property	Type	Description
`PageCount`	integer	Represents the total number of pages in the result set.
`PageNumber`	integer	Represents the current page number.
`GroupsTotal`	integer	Represents the total number of groups in the result set.
`PageSize`	integer	Represents how many groups are listed on each page.
`Groups`	Array of aws:SearchGroup	List of groups data.

Response Sample

The following example returns a single group.

JSON
XML

{
  "PageNumber": 1,
  "PageCount": 1,
  "PageSize": 2,
  "GroupsTotal": 2,
  "Groups": [
    {
      "GroupID": 1,
      "GroupName": "Pretty Women",
      "GroupSummary": "A selection of 20 girls that will keep you entertained all night",
      "Members": 2,
      "TotalRating": 6,
      "Escorts": 0,
      "WebcamPerformers": 0,
      "PhoneChatProviders": 0,
      "SMSChatProviders": 2,
      "FirstImageSafe": true,
      "FirstImage": "https://cdn1.adultwork.com/gs/t/1_1.jpg",
      "GroupType": "Parlour",
      "Country": "Philippines",
      "Region": null,
      "County": null
    },
    {
      "GroupID": 9,
      "GroupName": "Group2",
      "GroupSummary": "The greatest performers on the web",
      "Members": 3,
      "TotalRating": 21,
      "Escorts": 3,
      "WebcamPerformers": 0,
      "PhoneChatProviders": 0,
      "SMSChatProviders": 1,
      "FirstImageSafe":false,
      "FirstImage": "https://cdn1.adultwork.com/gs/t/9_1.jpg",
      "GroupType": "Sauna",
      "Country": null,
      "Region": null,
      "County": null
    }
  ]
}

        <Groups>
        <SearchGroup>
            <Country>Philippines</Country>
            <County i:nil="true" />
            <Escorts>0</Escorts>
            <FirstImageSafe>true</FirstImageSafe>
            <FirstImage>https://cdn1.adultwork.com/gs/t/110_1.jpg</FirstImage>
            <GroupID>1</GroupID>
            <GroupName>Pretty Women</GroupName>
            <GroupSummary>A selection of 20 girls that will keep you entertained all night </GroupSummary>
            <GroupType>Parlour</GroupType>
            <Members>2</Members>
            <PhoneChatProviders>0</PhoneChatProviders>
            <Region i:nil="true" />            <SMSChatProviders>2</SMSChatProviders>
            <TotalRating>6</TotalRating>
            <WebcamPerformers>0</WebcamPerformers>
        </SearchGroup>
        <SearchGroup>
            <Country>Netherlands</Country>
            <County i:nil="true" />
            <Escorts>3</Escorts>
            <FirstImageSafe>false</FirstImageSafe>
            <FirstImage>https://cdn1.adultwork.com/gs/T/9_2.jpg</FirstImage>
            <GroupID>9</GroupID>
            <GroupName>Group2</GroupName>
            <GroupSummary>The greatest performers on the web, only here on AdultWork!</GroupSummary>
            <GroupType>Sauna</GroupType>
            <Members>3</Members>
            <PhoneChatProviders>0</PhoneChatProviders>
            <Region i:nil="true" />
            <SMSChatProviders>1</SMSChatProviders>
            <TotalRating>21</TotalRating>
            <WebcamPerformers>0</WebcamPerformers>
        </SearchGroup>
    </Groups>
    <GroupsTotal>2</GroupsTotal>
    <PageCount>1</PageCount>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>