Website logo

Retrieve all enquiries made for a specific listing

Retrieve all enquiries made for a specific listing.

URL: https://api.trademe.co.nz/v1/listings/{listingId}/enquiries.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: None
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

listingId Integer (required)

The id of listing to get enquiries for.
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

endTime DateTime (optional)

The end time to return enquiries until. Optional.
page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.
rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 50.
startTime DateTime (optional)

The start time to return enquiries from. Optional.

Returns

<Enquiries>

A collection of enquiries

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.
Page Integer

The index of the current page of results (starts at 1).
PageSize Integer

The number of results in the current page.
List Collection of <Enquiry> or null

A list of the results in the current page.
Body String or null

The message body of the enquiry.
Date DateTime

The date the enquiry was made.
Enquirer <Member> or null

The enquirer's details.
MemberId Integer

The ID of the member. This may be 0, if we determine it is necessary to protect the member's privacy.
Nickname String or null

The nickname of the member. Some characters may be changed, if we determine it is necessary to protect the member's privacy.
DateAddressVerified DateTime

The date the member was address verified.
DateJoined DateTime

The date the member joined.
Email String or null

The member's email address.
UniqueNegative Integer

The number of distinct members who have placed negative feedback against this member.
UniquePositive Integer

The number of distinct members who have placed positive feedback against this member.
FeedbackCount Integer

The member's total feedback (UniquePositive minus UniqueNegative).
IsAddressVerified Boolean

Indicates whether the member has been address verified.
IsDealer Boolean

Indicates whether the member is a car dealer.
IsAuthenticated Boolean

Indicates whether the member is authenticated.
FirstName String or null

The member's first name
LastName String or null

The member's last name
PhoneNumber String or null

The member's phone number

Example XML Response (switch to JSON) 

<Enquiries xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <Enquiry>
      <Body>ABC</Body>
      <Date>2018-01-01T00:00:00Z</Date>
      <Enquirer>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <Email>ABC</Email>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
        <FirstName>ABC</FirstName>
        <LastName>ABC</LastName>
        <PhoneNumber>ABC</PhoneNumber>
      </Enquirer>
    </Enquiry>
    <Enquiry>
      <Body>ABC</Body>
      <Date>2018-01-01T00:00:00Z</Date>
      <Enquirer>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <Email>ABC</Email>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
        <FirstName>ABC</FirstName>
        <LastName>ABC</LastName>
        <PhoneNumber>ABC</PhoneNumber>
      </Enquirer>
    </Enquiry>
  </List>
</Enquiries>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "Body": "ABC",
      "Date": "\/Date(1514764800)\/",
      "Enquirer": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "Email": "ABC",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false,
        "FirstName": "ABC",
        "LastName": "ABC",
        "PhoneNumber": "ABC"
      }
    },
    {
      "Body": "ABC",
      "Date": "\/Date(1514764800)\/",
      "Enquirer": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "Email": "ABC",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false,
        "FirstName": "ABC",
        "LastName": "ABC",
        "PhoneNumber": "ABC"
      }
    }
  ]
}