Query parameters

• contact_id string

  Only this contact's activity; omit for the whole book. An id that is none of the agent's contacts is an empty page.

• actions array[string]

  Comma-separated action types (e.g. view,save); defaults to the full published set.

  Values are view, save, unsave, hide, unhide, rated, comment, request_showing, open_house_view, home_report_view, market_alert_view, or cma_view. Default value is ["view", "save", "unsave", "hide", "unhide", "rated", "comment", "request_showing", "open_house_view", "home_report_view", "market_alert_view", "cma_view"].

• from string(date-time)

  Only activity at or after this ISO-8601 timestamp; defaults to one year ago.

• to string(date-time)

  Only activity at or before this ISO-8601 timestamp.

• cursor string

  Opaque cursor from the previous page's next_cursor; a cursor another list issued is refused.

• limit integer

  Page size, 1 to 100.

  Minimum value is 1, maximum value is 100. Default value is 25.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • X-RateLimit-Limit integer

    Calls allowed in the current window.

  • X-RateLimit-Remaining integer

    Calls left in the current window.

  • X-RateLimit-Reset integer

    Epoch seconds at which the window resets.

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • id string Required
    • action string | null Required
    • created_at string(date-time) | null Required
    • contact object | null Required
      Hide contact attributes Show contact attributes object | null

      • id string Required
      • realscout_url string(uri) Required
    • rating integer | null Required
    • view_count integer | null Required
    • actionable object | null Required

      Any of:

      Property object | null HomeReport object | null MarketAlert object | null CmaReport object | null

      Hide attributes Show attributes

      • type string Required

        Value is Property.

      • id string | null Required
      • mls_number string | null Required
      • address string | null Required
      • city string | null Required
      • state string | null Required
      • zipcode string | null Required
      • price integer | null Required
      • status string | null Required
      • beds integer | null Required
      • baths number | null Required
      • realscout_url string(uri) | null Required
      • realscout_client_url string(uri) | null Required

      Hide attributes Show attributes

      • type string Required

        Value is HomeReport.

      • id string Required
      • address string | null Required
      • city string | null Required
      • state string | null Required
      • zipcode string | null Required
      • valuation integer | null Required
      • realscout_url string(uri) | null Required

      Hide attributes Show attributes

      • type string Required

        Value is MarketAlert.

      • id string Required
      • name string | null Required
      • price_min integer | null Required
      • price_max integer | null Required
      • realscout_url string(uri) | null Required

      Hide attributes Show attributes

      • type string Required

        Value is CmaReport.

      • id string Required
      • title string | null Required
      • subject_address string | null Required
      • realscout_url string(uri) | null Required
  • has_more boolean Required
  • next_cursor string | null Required

    Send as cursor for the next page; null on the last one.

• 400 application/json

  The request is invalid; field names the offending input when there is one. A body that is not valid JSON is refused before the API runs, as a bare 400 with no body.

  Hide response attribute Show response attribute object

  • error object Required
    Hide error attributes Show error attributes object

    • code string Required

      Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.

    • message string Required
    • field string

      The offending input, when one input is to blame.

    • request_id string Required

      Quote this when reporting a problem; it identifies the call in our logs.

• 401 application/json

  Invalid or missing bearer token.

  Hide response attribute Show response attribute object

  • error object Required
    Hide error attributes Show error attributes object

    • code string Required

      Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.

    • message string Required
    • field string

      The offending input, when one input is to blame.

    • request_id string Required

      Quote this when reporting a problem; it identifies the call in our logs.

• 403 application/json

  The credential was not granted the scope this call requires.

  Hide response attribute Show response attribute object

  • error object Required
    Hide error attributes Show error attributes object

    • code string Required

      Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.

    • message string Required
    • field string

      The offending input, when one input is to blame.

    • request_id string Required

      Quote this when reporting a problem; it identifies the call in our logs.

• 404 application/json

  Not found, or not yours: the two are indistinguishable on purpose.

  Hide response attribute Show response attribute object

  • error object Required
    Hide error attributes Show error attributes object

    • code string Required

      Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.

    • message string Required
    • field string

      The offending input, when one input is to blame.

    • request_id string Required

      Quote this when reporting a problem; it identifies the call in our logs.

• 429 application/json

  Rate limit exceeded; Retry-After says when to try again.

  Hide headers attribute Show headers attribute

  • Retry-After integer

    Seconds until the budget refills.

  Hide response attribute Show response attribute object

  • error object Required
    Hide error attributes Show error attributes object

    • code string Required

      Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.

    • message string Required
    • field string

      The offending input, when one input is to blame.

    • request_id string Required

      Quote this when reporting a problem; it identifies the call in our logs.

• 500 application/json

  Something went wrong on our side.

  Hide response attribute Show response attribute object

  • error object Required
    Hide error attributes Show error attributes object

    • code string Required

      Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.

    • message string Required
    • field string

      The offending input, when one input is to blame.

    • request_id string Required

      Quote this when reporting a problem; it identifies the call in our logs.