Alpha Only: This service is subject to change
This service is a work in progress. It is currently subject to change or removal without notice.

Notifications

Not to be confused with messages. This service provides access to details of prospecting notifications.

This service requires an OAuth 2 key.

  1. Supported Roles
  2. Available Services
    1. Listings in a Notification
  3. Notifications Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW Yes No
Portal Yes No
Private Yes No
More information about roles may be found here.

Listings in a Notification

/<API Version>/notifications/<Notification.Id>/listings

HTTP Method Description Conditional Notes
GET Provides the data for listings sent in the notification. Order is locked to what was sent in the notification. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the pagination block.

Notification Description

No other data is currently available for notifications. See the listings service documentation for response information.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.