---
title: "Query for a pageable list of guests."
method: GET
path: "/v2/guests"
tags: ["Guests"]
---

# Query for a pageable list of guests.

`GET /v2/guests`

Either q or created_since_utc is required.

## Query parameters

- `q` string, nullable
- `created_since_utc` string, date-time, nullable
- `from` string, date-time, nullable
- `to` string, date-time, nullable
- `include_tags` boolean
- `include_fields` boolean

## Response `200`

A pageable list of GuestModels representing the matching Guests.

- PageableEnumerableOfGuestModel — Represents a single page plus meta data for a collection of records.
  - `items` GuestModel[] — The subset of records for the current page in the collection.
    - `id` integer — The ID of this record.
    - `fields` FieldValueModel[] — A collection of field names and values.
      - `code` string
      - `value` string
    - `tags` string[] — A collection of tag names.
    - `addresses` AddressModel[]
      - `id` integer — The ID of this record.
      - `city` string
      - `country` string
      - `is_default` boolean
      - `postal_code` string
      - `province` string
      - `state` string
      - `street1` string
      - `street2` string
      - `type` 'home' | 'work' | 'other'
    - `email_addresses` EmailAddressModel[]
      - `id` integer — The ID of this record.
      - `address` string
      - `is_default` boolean
      - `type` 'home' | 'work' | 'mobile' | 'other'
    - `first_name` string
    - `is_banned` boolean
    - `last_name` string
    - `notes` string
    - `opt_out_marketing_email` boolean
    - `opt_out_marketing_sms` boolean
    - `opt_out_transactional_sms` boolean
    - `phones` PhoneModel[]
      - `id` integer — The ID of this record.
      - `extension` string
      - `is_default` boolean, nullable
      - `number` string
      - `type` 'home' | 'work' | 'mobile' | 'other'
  - `limit` integer — The maximum number of records per page.
  - `next_page_url` string — URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.
  - `offset` integer — The current offset from the start of the collection.

---

[API](https://skmtc.net/ownerrez/apis/ownerrez-api.md) · [All operations](https://skmtc.net/ownerrez/apis/ownerrez-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ownerrez/ownerrez-api/revisions/fa0c0f146039/schema)