> This page is optimized for agents. Use the linked Markdown pages and llms.txt indexes for related API content.

# Get Guest entities.

- Product: Guests
- Section: Guest
- Snapshot: Current
- Method: `GET`
- Path: `/api/guests/`

## Query parameters

### `dateFrom`

Type: `string`  
Required: no  

### `dateTo`

Type: `string`  
Required: no  

### `referenceDate`

Type: `string`  
Required: no  

### `name`

Type: `string`  
Required: no  

### `email`

Type: `string`  
Required: no  

### `organizationName`

Type: `string`  
Required: no  

### `postalCode`

Type: `string`  
Required: no  

### `locality`

Type: `string`  
Required: no  

### `phoneNumber`

Type: `string`  
Required: no  

### `membership`

Type: `string`  
Required: no  

### `registrationNumber`

Type: `string`  
Required: no  

### `source`

Type: `string`  
Required: no  

### `group`

Type: `number`  
Required: no  

### `type`

Type: `string`  
Required: no  

### `subscribed`

Type: `boolean`  
Required: no  

### `subscribedToNewsletter`

Type: `boolean`  
Required: no  

### `subscribedToInformativeMessages`

Type: `boolean`  
Required: no  

### `returning`

Type: `boolean`  
Required: no  

### `hasEmail`

Type: `boolean`  
Required: no  

### `createdSince`

Type: `string`  
Required: no  

### `modifiedSince`

Type: `string`  
Required: no  

### `offset`

Type: `number`  
Required: no  
Default: `0`  

### `limit`

Type: `number`  
Required: no  
Default: `100`  

### `accommodationCategory`

Type: `number`  
Required: no  

### `accommodation`

Type: `number`  
Required: no  

### `packageSpecification`

Type: `number`  
Required: no  

## Execute with TypeScript

Package: `@recranet/sdk`  

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

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

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

## Execute with curl

```bash
curl "https://app.recranet.com/api/guests/" \
    -H "X-Api-Key: $RECRANET_API_KEY"
```

## Responses

### Response `200`

Category: success  

Successful response

#### `application/json`

##### Generated example

```json
[
  {
    "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"
  }
]
```

##### Schema

###### object[]

Type: `object[]`  

###### object

Type: `object`  

###### `id`

Type: `number`  
Required: no  

###### `type`

Type: `string`  
Required: no  
Allowed values: `business`, `private`  

###### `salutation`

Type: `string`  
Required: no  
Allowed values: `male`, `female`, `family`  

###### `initials`

Type: `string`  
Required: no  

###### `firstName`

Type: `string`  
Required: no  

###### `surname`

Type: `string`  
Required: no  

###### `surnamePrefix`

Type: `string`  
Required: no  

###### `email`

Type: `string`  
Required: no  

###### `membership`

Type: `string`  
Required: no  

###### `address`

Type: `string`  
Required: no  

###### `addressNo`

Type: `string`  
Required: no  

###### `postalCode`

Type: `string`  
Required: no  

###### `locality`

Type: `string`  
Required: no  

###### `country`

Type: `string`  
Required: no  

###### `phoneNumber`

Type: `string`  
Required: no  

###### `phoneNumberHome`

Type: `string`  
Required: no  

###### `phoneNumberWork`

Type: `string`  
Required: no  

###### `birthDate`

Type: `string`  
Required: no  

###### `organizationName`

Type: `string`  
Required: no  

###### `vatNumber`

Type: `string`  
Required: no  

###### `companyRegistrationNumber`

Type: `string`  
Required: no  

###### `registrationNumbers`

Type: `string[]`  
Required: no  

###### string

Type: `string`  

###### `iban`

Type: `string`  
Required: no  

###### `ibanAccountName`

Type: `string`  
Required: no  

###### `bic`

Type: `string`  
Required: no  

###### `group`

Type: `string`  
Required: no  

###### `locale`

Type: `string`  
Required: no  

### Response `400`

Category: client-error  

Bad request

#### `application/json`

##### Example

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

##### Schema

###### object

Type: `object`  

## Related representations

- [Human documentation](/guests/methods/list/)
- [TypeScript Markdown](/guests/methods/list.md?lang=typescript)
- [curl Markdown](/guests/methods/list.md?lang=curl)
- [site llms.txt](/llms.txt)
- [product llms.txt](/guests/llms.txt)
- [snapshot llms.txt](/guests/llms.txt)