--- title: "List all guests" url: "https://docs.unified.to/property/guest/List_all_guests" description: "List all guests with Unified's Guest API (GET /property/{connection_id}/guest). Filter by limit, offset and updated_gte. Supported by 9 Guest integrations." date: "2026-10-29T08:41:27.988Z" updated: "2026-10-29T08:41:27.988Z" --- # List all guests Updated: October 29, 2026 GET/property/{connection\_id}/guest Returns a list of PropertyGuests. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported. ## Parameters **limit**number default=100 **offset**number default=0 **updated\_gte**date-time Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **sort** enum name updated\_at created\_at **order** enum asc desc **query**string Query string to search. eg. email address or name **listing\_id**string The property listing ID to filter by **fields**string array id created\_at updated\_at name first\_name last\_name emails telephones address language nationality company\_name image\_url notes metadata raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection ## Returns [PropertyGuest](https://docs.unified.to/property/guest/model.md)array **id**string unique identifier for the guest **created\_at**date-time when the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time when the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **name**string the guest full name **first\_name**string the guest first name **last\_name**string the guest last name **emails** array email addresses of the guest **telephones** array telephone numbers of the guest **address**object postal address of the guest **language**string the guest preferred language (ISO 639-1) **nationality**string the guest nationality **company\_name**string the guest company name **image\_url**string URL of the guest picture **notes**string free-text notes about the guest **metadata** array custom field values **raw** raw data from the integration ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const results = await sdk.property.listPropertyGuests({ connectionId, limit: 50, offset: 0, updated_gte: '2026-01-01T00:00:00.000Z', sort: 'updated_at', order: 'asc', query: '', listing_id: '', fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/guest', headers: { authorization: 'bearer .....' }, params: { limit: 50, offset: 0, updated_gte: '2026-01-01T00:00:00.000Z', sort: 'updated_at', order: 'asc', query: '', listing_id: '', fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/property/5de520f96e439b002043d8dc/guest?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&listing_id=&fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/property/5de520f96e439b002043d8dc/guest?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&listing_id=&fields=&raw= req, _ := http.NewRequest("GET", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/property/5de520f96e439b002043d8dc/guest?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&listing_id=&fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/property/5de520f96e439b002043d8dc/guest?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&listing_id=&fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/property/5de520f96e439b002043d8dc/guest?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&listing_id=&fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request GET \ --url 'https://api.unified.to/property/5de520f96e439b002043d8dc/guest?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&listing_id=&fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```