Get all enquiries for a specific office/agency

URL:	https://api.trademe.co.nz/v1/Property/Enquiries/Office.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	MyTradeMeRead: Read your membership & listing data.
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Query String parameters

endDate	String (optional)	Filter enquiries up to this date (YYYY-MM-DD format).
page	String (optional)	The page number to retrieve. Defaults to 1.
pageSize	String (optional)	The number of items per page. Defaults to 50, maximum 200.
startDate	String (optional)	Filter enquiries from this date onwards (YYYY-MM-DD format).

Returns

OfficeEnquiriesCollectionResponse

Page

Integer

The current page number

PageSize

Integer

The number of items per page

TotalCount

Integer

The total count of enquiries across all pages

List

Collection of <OfficeEnquiryResponse> or null

The list of enquiries for this page

ListingId	Integer	The listing ID associated with this enquiry
EnquiryDate	DateTime	The date and time when the enquiry was made
FirstName	String or null	The first name of the person making the enquiry
LastName	String or null	The last name of the person making the enquiry
Email	String or null	The email address of the person making the enquiry
ReceiverEmail	String or null	The email address that received the enquiry
PhoneNumber	String or null	The phone number of the person making the enquiry
Message	String or null	The enquiry message content
IsAuthenticated	Boolean	Indicates if the enquirer is authenticated
EnquirerWantsAppraisal	Boolean	Indicates if the enquirer wants an appraisal
PropertyFilesUnlocked	Boolean	Indicates if property files have been unlocked for this enquirer

Example XML Response (switch to JSON)

<OfficeEnquiriesCollectionResponse xmlns="http://api.trademe.co.nz/v1">
  <Page>123</Page>
  <PageSize>123</PageSize>
  <TotalCount>123</TotalCount>
  <List>
    <OfficeEnquiryResponse>
      <ListingId>123</ListingId>
      <EnquiryDate>2018-01-01T00:00:00Z</EnquiryDate>
      <FirstName>ABC</FirstName>
      <LastName>ABC</LastName>
      <Email>ABC</Email>
      <ReceiverEmail>ABC</ReceiverEmail>
      <PhoneNumber>ABC</PhoneNumber>
      <Message>ABC</Message>
      <IsAuthenticated>false</IsAuthenticated>
      <EnquirerWantsAppraisal>false</EnquirerWantsAppraisal>
      <PropertyFilesUnlocked>false</PropertyFilesUnlocked>
    </OfficeEnquiryResponse>
    <OfficeEnquiryResponse>
      <ListingId>123</ListingId>
      <EnquiryDate>2018-01-01T00:00:00Z</EnquiryDate>
      <FirstName>ABC</FirstName>
      <LastName>ABC</LastName>
      <Email>ABC</Email>
      <ReceiverEmail>ABC</ReceiverEmail>
      <PhoneNumber>ABC</PhoneNumber>
      <Message>ABC</Message>
      <IsAuthenticated>false</IsAuthenticated>
      <EnquirerWantsAppraisal>false</EnquirerWantsAppraisal>
      <PropertyFilesUnlocked>false</PropertyFilesUnlocked>
    </OfficeEnquiryResponse>
  </List>
</OfficeEnquiriesCollectionResponse>

Example JSON Response (switch to XML)

{
  "Page": 123,
  "PageSize": 123,
  "TotalCount": 123,
  "List": [
    {
      "ListingId": 123,
      "EnquiryDate": "\/Date(1514764800)\/",
      "FirstName": "ABC",
      "LastName": "ABC",
      "Email": "ABC",
      "ReceiverEmail": "ABC",
      "PhoneNumber": "ABC",
      "Message": "ABC",
      "IsAuthenticated": false,
      "EnquirerWantsAppraisal": false,
      "PropertyFilesUnlocked": false
    },
    {
      "ListingId": 123,
      "EnquiryDate": "\/Date(1514764800)\/",
      "FirstName": "ABC",
      "LastName": "ABC",
      "Email": "ABC",
      "ReceiverEmail": "ABC",
      "PhoneNumber": "ABC",
      "Message": "ABC",
      "IsAuthenticated": false,
      "EnquirerWantsAppraisal": false,
      "PropertyFilesUnlocked": false
    }
  ]
}