Interactive API Documentation

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Search

  • List Methods
  • Expand Methods

  • GET Query /ob-20110511/test/search

    This method allows you to search Sensis.

    Parameter	Value	Type	Description
    query		string	What to search for. Required unless location is used
    location		string	Location to search in. Can be in the following formats: Suburb or Locality, Postcode, Geographical coordinates, State or Territory. Required unless query is used.
    page		number	Page number to return
    rows		number	Number of listings to return per page
    sortBy		string	Listing sort order
    sensitiveCategories	True False	boolean	Filtering potentially unsafe content.
    categoryId		string	Filter listings returned by category id.
    postcode		string	Filter listings returned by postcode.
    radius		string	Filter listings returned to those within the radius distance of the location.
    locationTiers		integer	Filter listings returned to those within a number of location tiers of the location
    suburb		string	Filter listings returned to those within the given suburb. Repeat the parameter to include multiple suburbs in the filter.
    state	ACT NSW NT QLD SA TAS VIC WA	enum	Filter listings returned to those within the given state. Repeat the parameter to include multiple states in the filter.
    boundingBox		string	Filter listings returned to those within a bounding box.
    content		string	Filter listings returned to only those with certain types of content.
    productKeyword		string	Filter listings returned to only those containing certain product keywords.

• Get by Listing ID

  • List Methods
  • Expand Methods

  • GET getByListingID /ob-20110511/test/getByListingId

    This method returns a single listing given its unique ID.

    Parameter	Value	Type	Description
    query		string	This is the id field of the listing
    includeReviews	True False	boolean	A value of true will mean the response will contain the reviewSummaries and maximum of 10 reviews in the response
    includePois	True False	boolean	A value of true will mean the response will contain up to a maximum of 10 points of interest (Eg. railway stations, car parks, ATMs) in the response
    categoryId		string	See POI Category Filtering for details

• Reviews

  • List Methods
  • Expand Methods

  • GET Reviews /v1/test/businesses/:aboutId/reviews

    This method returns user reviews with additional parametric filtering.

    Parameter	Value	Type	Description
    :aboutId		string	The business whose reviews you are looking for's identifier. This can be found by performing a /search as described above
    sortType	DATE RATING	enum	DATE - the date reviews are submitted, RATING - the number of ratings for each of the review.
    sortOrder	ASC DESC	enum	Sort the reviews, either smallest to largest, or largest to smallest
    offset		number	Zero based number of reviews to start pagination from
    limit		number	The number of reviews after offset to return
    namespace		string	Filter for reviews within a given namespace returned, eg http://www.yelp.com.au