# Query Propertybase listings

**GET /pba__WebserviceListingsQuery**

Retrieve listings from Propertybase with filtering, sorting, and pagination. Returns XML or JSON.


## Servers
- Your Propertybase webservice endpoint (Setup > Sites > Custom URLs): https://yourendpoint (Your Propertybase webservice endpoint (Setup > Sites > Custom URLs))
- Propertybase Ingestion API (staging): https://pb-integrations-api-staging.herokuapp.com (Propertybase Ingestion API (staging))
- WebToProspect endpoint: https://yoursitename.secure.force.com (WebToProspect endpoint)


## Authentication methods
- Bearer token
- Api key


## Parameters


### Query parameters

- **token** (string)
  Your webserviceWebListings_token

- **fields** (string)
  Semicolon-separated field API names (e.g., name;pba__ListingPrice_pb__c;pba__Bedrooms_pb__c)

- **itemsperpage** (integer)
  Number of results per page (default: 20, max: 1000)

- **page** (integer)
  Page number (0-indexed)

- **orderby** (string)
  Sort field and direction (e.g., pba__ListingPrice_pb__c;ASC)

- **getimages** (boolean)
  Include image URLs

- **getvideos** (boolean)
  Include video URLs

- **getdocuments** (boolean)
  Include document URLs

- **debugmode** (boolean)
  Include debug messages in response



## Responses
### 200
Successful query response

#### Body: application/json (object)
- **page** (integer)
  Current page number (0-indexed)

- **listingsPerPage** (integer)
  Number of listings per page

- **numberOfListings** (integer)
  Total listings matching filter

- **fatalError** (boolean)
  Whether a fatal error occurred

- **errorMessages** (array[string])
  Any error messages

- **debugMessages** (array[string])
  Debug messages (if debugmode=true)

- **listings** (array[object])
  Array of matching listings


### 400
Invalid query parameters

### 401
Invalid or missing token


[Powered by Bump.sh](https://bump.sh)