Messages

Fetch all messages on a single thread.

Changed on

OAuth app required. Personal Access Tokens can't call messaging endpoints. Using your own account? Create an OAuth app and click Grant Access To Me — that's it. Third-party apps need a signed messaging agreement (email partnerhelp@ownerrez.com with the subject Messaging API Access). Otherwise every call returns 402 messaging_not_enabled.

get/v2/messages

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/messages
  • Auth
    • HTTP bearer
    • or HTTP basic

Query parameters

threadIdinteger required

The thread to read: an id from thread_ids on a booking, inquiry or quote.

since_utcstring date-time nullable

Only messages after a specific date/time, or null for all messages.

include_draftsboolean

Include unsent drafts in results.

include_attachmentsboolean

Include attachments in the results.

limitinteger

Maximum records to return. Default 20, maximum 100.

offsetinteger

Deprecated: rejected above 0 from 2027-01-05. Follow next_page_url instead. Records to skip from the start of the collection. Default 0.

cursorstring

Opaque cursor from a previous response's next_page_url. Prefer following that link over computing offsets: a cursor pages by record id, so rows inserted while you page are not skipped or repeated. A cursor issued under different filters is ignored and paging falls back to offset.

Response

A pageable enumeration of messages.

limitinteger

The maximum number of records per page.

next_page_urlstring

URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.

offsetinteger

The current offset from the start of the collection.

Changes

    • warning

      added the new nalren enum value to the ///////// response property for the response status

    • warning

      added the new nalren enum value to the /// response property for the response status

    • info

      query request parameter offset was deprecated