> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search Visitors > Search and list Visitor records with filtering, sorting, and pagination. ## Authentication This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header. The authenticated user must be a full unrestricted administrator or have the **`Visitor-List`** role. ## Enums | Value | Name | | ----- | ------------- | | 1 | Administrator | | 2 | NexIO | | 3 | Customer | | Value | Name | | ----- | ---------------- | | 1 | NotRequired | | 2 | Requested | | 3 | Rejected | | 4 | AcceptedAndHold | | 5 | AcceptedAndGrant | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by Business Id. Filter by visitor full name. Filter by visitor email. Filter by Coworker Id. Filter by host coworker type. Filter by host coworker full name. Filter by host coworker company name. Filter by host coworker billing name. Filter by host coworker email. Filter by host coworker team names. Filter by visitor source. Filter by host approval status. Filter by visitor code. Filter by location checked in at. Filter by notes. Filter by customer notes. Filter by reason for visit. Filter by visitor company name. Filter by visitor phone number. Filter by expected arrival date and time. Filter by whether the visitor has arrived. Filter by actual arrival date. Filter by departure date. Filter by Notified. Filter by Internal. Filter by whether this is a tour visit. Filter by whether the visitor has agreed to terms. Filter by whether the tour is confirmed. Filter by Access Control Scheduled Job Id. Filter by check in the visitor now. ### Range Filters Filter by expected arrival date and time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by expected arrival date and time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by actual arrival date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by actual arrival date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by departure date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by departure date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/visitors?page=1&size=15&orderBy=FullName&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/visitors?' + new URLSearchParams({ page: 1, size: 15, orderBy: 'FullName', dir: 1 // Ascending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/visitors', params={ 'page': 1, 'size': 15, 'orderBy': 'FullName', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Filtering by FullName ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/visitors?Visitor_FullName=example-value&orderBy=FullName&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/visitors?' + new URLSearchParams({ Visitor_FullName: 'example-value', orderBy: 'FullName', dir: 1 }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/visitors', params={ 'Visitor_FullName': 'example-value', 'orderBy': 'FullName', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Range filters ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/visitors?from_Visitor_UpdatedOn=2025-01-01T00:00&to_Visitor_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/visitors?' + new URLSearchParams({ from_Visitor_UpdatedOn: '2025-01-01T00:00', to_Visitor_UpdatedOn: '2025-12-31T23:59', orderBy: 'UpdatedOn', dir: 1 // Descending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/visitors', params={ 'from_Visitor_UpdatedOn': '2025-01-01T00:00', 'to_Visitor_UpdatedOn': '2025-12-31T23:59', 'orderBy': 'UpdatedOn', 'dir': 1 // Descending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ## Response ### 200 The list of Visitor records matching the query. See the [Get one Visitor](/rest-api/spaces/get-visitors-by-id) endpoint for the full list of properties returned for each record. **Partial records** — The listing endpoint returns a summary representation of each Visitor. The following fields are **not populated** in the `Records[]` response: `VisitorSource`, `HostApprovalStatus`, `CheckedInAt`, `Notes`, `CustomerNotes`, `ArrivalDate`, `DepartureDate`, `CheckInNow`. To get all fields, fetch the full record using the [Get one Visitor](/rest-api/spaces/get-visitors-by-id) endpoint. **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "Records": [ { "BusinessId": 0, "FullName": "", "Email": "", "CoworkerId": null, "CoworkerCoworkerType": null, "CoworkerFullName": null, "CoworkerCompanyName": null, "CoworkerBillingName": null, "CoworkerEmail": null, "CoworkerTeamNames": null, "VisitorCode": null, "VisitReason": null, "CompanyName": null, "PhoneNumber": null, "ExpectedArrival": null, "Arrived": false, "Notified": false, "Internal": false, "IsTour": false, "HasAgreedTerms": false, "TourConfirmed": false, "AccessControlScheduledJobId": null, "Id": 87654321, "UpdatedOn": "2025-01-15T10:30:00Z", "CreatedOn": "2025-01-10T08:00:00Z", "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "UpdatedBy": "admin@example.com", "IsNew": false, "SystemId": null, "ToStringText": "Visitor Example", "LocalizationDetails": null, "CustomFields": null } ], "CurrentPageSize": 15, "CurrentPage": 1, "CurrentOrderField": "FullName", "CurrentSortDirection": 1, "FirstItem": 1, "HasNextPage": false, "HasPreviousPage": false, "LastItem": 1, "PageNumber": 1, "PageSize": 15, "TotalItems": 1, "TotalPages": 1 } ```