Lookup Reservation entity by phone number.

GETRequest

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

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

const result = await client.voip.lookup({
  phoneNumber: "<phoneNumber>",
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 1000,
    "token": "fdffb9ad-eeba-40da-9592-23b2c6ee067a",
    "number": "2024-0001",
    "name": "Cash",
    "date": "2024-04-01T12:12:00Z",
    "dateFrom": "2024-05-09T00:00:00Z",
    "dateTo": "2024-05-12T00:00:00Z",
    "checkin": "2024-05-09T14:00:00Z",
    "checkout": "2024-05-12T11:00:00Z",
    "checkinFormatted": "2024-05-09T14:00:00Z",
    "checkoutFormatted": "2024-05-12T11:00:00Z",
    "accommodationTitle": "Comfortplaats Standaard",
    "accommodationUnitNumber": "039",
    "locale": "nl",
    "url": "https://app.recranet.com/nl/dashboard/reservations/1000?token=fdffb9ad-eeba-40da-9592-23b2c6ee067a",
    "guest": {
      "id": 1000,
      "firstName": "Johnny",
      "surname": "Cash",
      "surnamePrefix": "",
      "phoneNumber": "+31612345678",
      "phoneNumberHome": "+31118202019",
      "phoneNumberWork": "+31118202019",
      "locality": "Middelburg",
      "country": "NL",
      "locale": "nl"
    }
  }
]

Response 400

Bad request

application/json

Example 1

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

Query parameters

• phoneNumberstringrequired

Returns

Array of object

Schema shown for 200 · application/json

• idnumberoptional
• tokenstringoptional
• numberstringoptional
• namestringoptional
• datestringoptional
• dateFromstringoptional
• dateTostringoptional
• checkinstringoptional
• checkoutstringoptional
• checkinFormattedstringoptional
• checkoutFormattedstringoptional
• accommodationTitlestringoptional
• accommodationUnitNumberstringoptional
• localestringoptional
• urlstringoptional
• guestobjectoptional
  Show 10 properties

  • idnumberoptional
  • firstNamestringoptional
  • surnamestringoptional
  • surnamePrefixstringoptional
  • phoneNumberstringoptional
  • phoneNumberHomestringoptional
  • phoneNumberWorkstringoptional
  • localitystringoptional
  • countrystringoptional
  • localestringoptional