Get ReviewInvitation entities.

Fetches ReviewInvitation entities. The dateFrom/dateTo range filters on the reservation, with referenceDate choosing the field, with the same range behavior as the reservation summaries endpoint; all three must be used together. Unsent invitations for reservations that departed yesterday can be fetched with status=unsent, referenceDate=date-to and dateFrom/dateTo set to yesterday. Each entity contains a url that redirects the guest to the review page; it can be used in an email as-is.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.reviewInvitations.list();

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 0,
    "token": "token",
    "url": "url",
    "sent": "sent"
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• statusstringoptional
• dateFromstringoptional
• dateTostringoptional
• referenceDatestringoptional
• offsetnumberoptional
  Default: 0
• limitnumberoptional
  Default: 25

Returns

Array of ReviewInvitation

Schema shown for 200 · application/json

• idnumber
• tokenstring
• urlstring
• sentstringoptional