Skip to main content

 Web service API

How to use PageSeeder's Web service API

find group image

/groups/{group}/images/find [GET]


Use Service: /groups/{group}/search [GET] with filters=pssubtype:image instead.

Find images in the current group matching the criteria specified in the request.


NameDescriptionRequiredTypeDefault value
folderThe folder containing the images (includes subfolders)nopath
pageThe result page for when results span over multiple pagesnolong1
pagesizeThe number of results per pagenolong20
prefixThe prefix the images must start withno string


This service is restricted to guest and higher.


The XML format is based on search query and results:

  <search-results index="[Index ID]">
    <query lucene="[lucene query]">
      <!-- Format of graphics query may change without notice -->
      <graphic-query empty="false"
          <format name="JPEG" mediatype="image/jpeg"/>
          <format name="GIF" mediatype="image/gif"/>
          <format name="PNG" mediatype="image/png"/>
          <format name="BMP" mediatype="image/bmp"/>
        <sort by="relevance"/>
        <score>[score between 0 and 1]</score>
        <field name="psid">[URI ID]</field>
        <field name="pstitle">[URI Title]</field>
        <field name="pstype">document</field>
        <field name="psmediatype">[media type (starts with 'image/')]
        <field name="psmodifieddate" datetime="[datetime]">[datetime]
        <field name="psfilename">[URI File name]</field>
        <field name="psurifolder">[URI Folder]</field>
        <field name="psfolder">[URI Folder]</field>
        <field name="pssize">[File size in bytes]</field>
        <field name="psdocid">[Doc ID]</field>
        <!-- The image dimension may not always be available -->
        <field name="pswidth">[Image width in pixels]</field>
        <field name="psheight">[Image height in pixels]</field>

Error Handling

No specific errors expected for this service.

Created on , last edited on