Get Guest entities.

GETRequest

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

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

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

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 1000,
    "type": "private",
    "salutation": "male",
    "initials": "J.",
    "firstName": "Johnny",
    "surname": "Cash",
    "surnamePrefix": null,
    "email": "johnny@example.com",
    "membership": null,
    "address": "Akkerstraat",
    "addressNo": "143",
    "postalCode": "5293AJ",
    "locality": "Gemonde",
    "country": "NL",
    "phoneNumber": "+31612345678",
    "phoneNumberHome": "+31118202019",
    "phoneNumberWork": "+31118202019",
    "birthDate": "1992-07-02T00:00:00Z",
    "organizationName": null,
    "vatNumber": null,
    "companyRegistrationNumber": "12345678",
    "registrationNumbers": [
      "ABC123"
    ],
    "iban": null,
    "ibanAccountName": null,
    "bic": null,
    "group": "nl",
    "locale": "nl"
  }
]

Response 400

Bad request

application/json

Example 1

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

Query parameters

• dateFromstringoptional
• dateTostringoptional
• referenceDatestringoptional
• namestringoptional
• emailstringoptional
• organizationNamestringoptional
• postalCodestringoptional
• localitystringoptional
• phoneNumberstringoptional
• membershipstringoptional
• registrationNumberstringoptional
• sourcestringoptional
• groupnumberoptional
• typestringoptional
• subscribedbooleanoptional
• subscribedToNewsletterbooleanoptional
• subscribedToInformativeMessagesbooleanoptional
• returningbooleanoptional
• hasEmailbooleanoptional
• createdSincestringoptional
• modifiedSincestringoptional
• offsetnumberoptional
  Default: 0
• limitnumberoptional
  Default: 100
• accommodationCategorynumberoptional
• accommodationnumberoptional
• packageSpecificationnumberoptional

Returns

Array of object

Schema shown for 200 · application/json

• idnumberoptional
• typestringoptional
  Allowed values: business, private
• salutationstringoptional
  Allowed values: male, female, family
• initialsstringoptional
• firstNamestringoptional
• surnamestringoptional
• surnamePrefixstringoptional
• emailstringoptional
• membershipstringoptional
• addressstringoptional
• addressNostringoptional
• postalCodestringoptional
• localitystringoptional
• countrystringoptional
• phoneNumberstringoptional
• phoneNumberHomestringoptional
• phoneNumberWorkstringoptional
• birthDatestringoptional
• organizationNamestringoptional
• vatNumberstringoptional
• companyRegistrationNumberstringoptional
• registrationNumbersstring[]optional
• ibanstringoptional
• ibanAccountNamestringoptional
• bicstringoptional
• groupstringoptional
• localestringoptional