Get Gallery

Use this method to get a the private gallery of an AdultWork.com member.

Your project needs to be approved to be able to use this endpoint. Submitting your project is easy. Open your Project and click Start Submission.

In order to have the API return the images, the authenticated user must be subscribed to the gallery. See the example Subscribe to gallery

URL / Endpoint

Need help with Postman?

GET /v1/Pictures/GetGallery

GET /v1/Groups/Pictures/GetGallery (See Group manager)

Request

Property	Type	Description
`UserID`	integer	Required. The User ID of the AdultWork.com member you wish the API to return the gallery of.
`AlbumID`	integer	The ID of the album the gallery you wish the API to return.
`OrderBy`	string	Sets the order in which the pictures will be returned. Default is dateuploaded. Order options are `dateuploaded`, `gallerysize`, `galleryprice` and `size`.
`PageSize`	integer	Sets the number of pictures on each page of the result set. Accepts values from `1` to `100`. Default it `50`.
`PageNumber`	integer	Returns a specific page in the result set. Accepts values from `1` onwards.

Group manager

If the authenticated user is the manager of a group, the user can impersonate another member of the group. This allows the manager to perform tasks of other group members without having to authenticate as them.

The request can be build in the same way as the regular request, but targeted towards the Group manager endpoint. It re-uses the existing UserID property to set the ID of the group member. This means you can only use the Group manager version of this endpoint to get data from your group members.

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 if you don't supply the Authorization header 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 let the API return the correct image paths, this is required.

Note: this can only be done when the authenticated user has a valid subscription. When using the Authorization header with a valid access_token do not use the API-Key.

Scopes

This endpoint does not require any additional scopes.

Samples

GET method

GET https://api.adultwork.com/v1/pictures/getGallery?UserID=123456

Authorization: bearer {your-access-token}

GET as Group manager

GET https://api.adultwork.com/v1/Groups/pictures/getGallery?UserID=123456

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`PageNumber`	integer	Represents the current page number.
`PageCount`	integer	Represents the total number of pages in the result set.
`PageSize`	integer	Represents how many pictures are listed on each page.
`PicturesTotal`	integer	Represents the total number of pictures in the result set.
`Pictures`	Array of aws:Picture	List of pictures data.

Response Sample

The following example shows the picture of one user. If the authenticated user is subscribed to the private gallery of the owner the ThumbUrl, PreviewUrl and FileUrl will have values.

JSON
XML

{
  "PageNumber": 1,
  "PageCount": 1,
  "PageSize": 1,
  "PicturesTotal": 1,
  "Pictures": [
    {
      "PictureID": 1,
      "Title": "Picture Title",
      "Description": "Picture Description",
      "ThumbSafe": false,
      "ThumbUrl": null,
      "PreviewSafe": false,
      "PreviewUrl": null,
      "FileSafe": false,
      "FileUrl": null,
      "Width": 1024,
      "Height": 768,
      "FileSize": 247069,
      "NonNude": false,
      "DateAdded": "2015-09-19T12:36:02.71",
      "AlbumId": null,
      "Gallery": {
        "GallerySize": 58,
        "RegistrationDuration": 7,
        "RegistrationPrice": 1.20
      },
      "User": {
        "UserID": 123456,
        "Nickname": "JosepheneBlogs",
        "IsEscort": true,
        "IsWebcam": false,
        "IsPhoneChat": false,
        "IsSMSChat": true,
        "AvailableTodayEscort": false,
        "AvailableNowWebcam": true,
        "AvailableNowPhoneChat": true,
        "Age": 21,
        "Ratings": {
          "Total": 33,
          "Positive": 34,
          "Neutral": 0,
          "Negative": 1,
          "Ratings": 35,
          "Disputes": 0
        }
      }
    },...
  ]
}

<PictureSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">
    <PageCount>1</PageCount>
    <PageNumber>1</PageNumber>
    <PageSize>1</PageSize>
    <Pictures>
        <PictureResult>
            <AlbumId i:nil="true" />
            <DateAdded>2015-09-19T12:36:02.71</DateAdded>
            <Description>Picture Description</Description>
            <FileSafe>false</FileSafe>
            <FileSize>247069</FileSize>
            <FileUrl i:nil="true" />
            <Gallery>
                <GallerySize>58</GallerySize>
                <RegistrationDuration>7</RegistrationDuration>
                <RegistrationPrice>1.2000</RegistrationPrice>
            </Gallery>
            <Height>768</Height>
            <NonNude>false</NonNude>
            <PictureID>1</PictureID>
            <PreviewSafe>false</PreviewSafe>
            <PreviewUrl i:nil="true" />
            <ThumbSafe>false</ThumbSafe>
            <ThumbUrl i:nil="true" />
            <Title>Picture Title</Title>
            <User>
                <Age>21</Age>
                <AvailableNowPhoneChat>true</AvailableNowPhoneChat>
                <AvailableNowWebcam>true</AvailableNowWebcam>
                <AvailableTodayEscort>false</AvailableTodayEscort>
                <IsEscort>true</IsEscort>
                <IsPhoneChat>false</IsPhoneChat>
                <IsSMSChat>true</IsSMSChat>
                <IsWebcam>false</IsWebcam>
                <Nickname>JosepheneBlogs</Nickname>
                <Ratings xmlns:d5p1="http://schemas.datacontract.org/2004/07/API.Models.Profile">
                    <d5p1:Disputes>0</d5p1:Disputes>
                    <d5p1:Negative>1</d5p1:Negative>
                    <d5p1:Neutral>0</d5p1:Neutral>
                    <d5p1:Positive>34</d5p1:Positive>
                    <d5p1:Ratings>35</d5p1:Ratings>
                    <d5p1:Total>33</d5p1:Total>
                </Ratings>
                <UserID>123456</UserID>
            </User>
            <Width>1024</Width>
        </PictureResult>
	 </Pictures>
</PictureSearchResult>