GET api/v1/VisitorRequests?OccupancyId={OccupancyId}
Returns a list of VisitorViewModels from a given Facility that the API token has rights to view
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| OccupancyId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of VisitorViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| VisitorRequestId |
Represents the PK of an existing Visitor Request in BluSKY |
globally unique identifier |
None. |
| GuestPersonId |
Represents the PK of an existing Visitor Request Guest in BluSKY |
globally unique identifier |
None. |
| GuestFirstName |
Represents the Guest's first/given name. |
string |
None. |
| GuestLastName |
Represents the Guest's last name / surname. |
string |
None. |
| GuestEmail |
Represents the email address of the Guest |
string |
None. |
| GuestPhone |
Represents the phone number of the Guest |
string |
None. |
| GuestCompanyName |
Represents the name of the occupancy or vendor instance that the Guest belongs to |
string |
None. |
| GroupHashTag |
Represents the group name that the Guest may belong to (if provided) |
string |
None. |
| VisitationPattern |
Represents the visitation pattern that has been requested for the Guest |
string |
None. |
| Message |
Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives |
string |
None. |
| VisitorTypeId |
Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives |
globally unique identifier |
None. |
| HostPersonId |
Represents the PK of an existing Visitor Request Host in BluSKY |
globally unique identifier |
None. |
| HostFirstName |
Represents the Host's first/given name. |
string |
None. |
| HostLastName |
Represents the Host's last name / surname. |
string |
None. |
| HostEmail |
Represents the email address of the Host |
string |
None. |
| HostPhone |
Represents the phone number of the Host |
string |
None. |
| HostCompanyName |
Represents the name of the occupancy or vendor instance that the Host belongs to |
string |
None. |
| FacilityId |
Represents the PK of the facility that the Guest is expected at |
globally unique identifier |
None. |
| FacilityName |
Represents the name of the facility that the Guest is expected at |
string |
None. |
| ACSystemId |
Represents the PK of the Access Control System that the Host is located in |
globally unique identifier |
None. |
| ACSystemName |
Represents the name of the Access Control System that the Host is located in |
string |
None. |
| RequestedAccessLevel |
Represents an Access Level assignments requested by the Requestor for the Visitor |
AccessLevelViewModel |
None. |
| Deleted |
Represents whether the Visitor Request is deleted or not. |
boolean |
None. |
Response Formats
application/json, text/json
[
{
"VisitorRequestId": "02d60727-576b-43a4-a6e9-a46c643fe6f7",
"GuestPersonId": "bed1281b-1b2f-4b58-9868-203bcd3e389b",
"GuestFirstName": "sample string 3",
"GuestLastName": "sample string 4",
"GuestEmail": "sample string 5",
"GuestPhone": "sample string 6",
"GuestCompanyName": "sample string 7",
"GroupHashTag": "sample string 8",
"VisitationPattern": "sample string 9",
"Message": "sample string 10",
"VisitorTypeId": "0d166597-08ac-4602-8ea6-809824b11f89",
"HostPersonId": "7050748b-a50e-4864-8450-6a505bc4f467",
"HostFirstName": "sample string 13",
"HostLastName": "sample string 14",
"HostEmail": "sample string 15",
"HostPhone": "sample string 16",
"HostCompanyName": "sample string 17",
"FacilityId": "9f5b43ae-bc7d-4cb3-8cd7-edc6c7d09621",
"FacilityName": "sample string 18",
"ACSystemId": "a80bbfae-67d4-44aa-9240-afc7e9a6b2aa",
"ACSystemName": "sample string 19",
"RequestedAccessLevel": {
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2025-10-12T01:44:07.2342294+00:00",
"AccessLevelEndDate": "2025-10-12T01:44:07.2342294+00:00",
"Deleted": true,
"ACSystemId": "ba019853-803b-4af8-8511-c3b1d2ad2aa2",
"CompanyId": "448ce9aa-7a41-447a-9cf2-778edf540778",
"ApplyByDefault": true,
"AccessLevelTypeId": "2c686d3a-05ac-4121-8124-f316272c0e62",
"FacilityId": "ddf2bdfe-13cb-40fd-89ac-63fbd07baba8"
},
"Deleted": true
},
{
"VisitorRequestId": "02d60727-576b-43a4-a6e9-a46c643fe6f7",
"GuestPersonId": "bed1281b-1b2f-4b58-9868-203bcd3e389b",
"GuestFirstName": "sample string 3",
"GuestLastName": "sample string 4",
"GuestEmail": "sample string 5",
"GuestPhone": "sample string 6",
"GuestCompanyName": "sample string 7",
"GroupHashTag": "sample string 8",
"VisitationPattern": "sample string 9",
"Message": "sample string 10",
"VisitorTypeId": "0d166597-08ac-4602-8ea6-809824b11f89",
"HostPersonId": "7050748b-a50e-4864-8450-6a505bc4f467",
"HostFirstName": "sample string 13",
"HostLastName": "sample string 14",
"HostEmail": "sample string 15",
"HostPhone": "sample string 16",
"HostCompanyName": "sample string 17",
"FacilityId": "9f5b43ae-bc7d-4cb3-8cd7-edc6c7d09621",
"FacilityName": "sample string 18",
"ACSystemId": "a80bbfae-67d4-44aa-9240-afc7e9a6b2aa",
"ACSystemName": "sample string 19",
"RequestedAccessLevel": {
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2025-10-12T01:44:07.2342294+00:00",
"AccessLevelEndDate": "2025-10-12T01:44:07.2342294+00:00",
"Deleted": true,
"ACSystemId": "ba019853-803b-4af8-8511-c3b1d2ad2aa2",
"CompanyId": "448ce9aa-7a41-447a-9cf2-778edf540778",
"ApplyByDefault": true,
"AccessLevelTypeId": "2c686d3a-05ac-4121-8124-f316272c0e62",
"FacilityId": "ddf2bdfe-13cb-40fd-89ac-63fbd07baba8"
},
"Deleted": true
}
]
application/xml, text/xml
<ArrayOfVisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<VisitorViewModel>
<ACSystemId>a80bbfae-67d4-44aa-9240-afc7e9a6b2aa</ACSystemId>
<ACSystemName>sample string 19</ACSystemName>
<Deleted>true</Deleted>
<FacilityId>9f5b43ae-bc7d-4cb3-8cd7-edc6c7d09621</FacilityId>
<FacilityName>sample string 18</FacilityName>
<GroupHashTag>sample string 8</GroupHashTag>
<GuestCompanyName>sample string 7</GuestCompanyName>
<GuestEmail>sample string 5</GuestEmail>
<GuestFirstName>sample string 3</GuestFirstName>
<GuestLastName>sample string 4</GuestLastName>
<GuestPersonId>bed1281b-1b2f-4b58-9868-203bcd3e389b</GuestPersonId>
<GuestPhone>sample string 6</GuestPhone>
<HostCompanyName>sample string 17</HostCompanyName>
<HostEmail>sample string 15</HostEmail>
<HostFirstName>sample string 13</HostFirstName>
<HostLastName>sample string 14</HostLastName>
<HostPersonId>7050748b-a50e-4864-8450-6a505bc4f467</HostPersonId>
<HostPhone>sample string 16</HostPhone>
<Message>sample string 10</Message>
<RequestedAccessLevel>
<ACSystemId>ba019853-803b-4af8-8511-c3b1d2ad2aa2</ACSystemId>
<AccessLevelEndDate>2025-10-12T01:44:07.2342294+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-10-12T01:44:07.2342294+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>448ce9aa-7a41-447a-9cf2-778edf540778</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</RequestedAccessLevel>
<VisitationPattern>sample string 9</VisitationPattern>
<VisitorRequestId>02d60727-576b-43a4-a6e9-a46c643fe6f7</VisitorRequestId>
<VisitorTypeId>0d166597-08ac-4602-8ea6-809824b11f89</VisitorTypeId>
</VisitorViewModel>
<VisitorViewModel>
<ACSystemId>a80bbfae-67d4-44aa-9240-afc7e9a6b2aa</ACSystemId>
<ACSystemName>sample string 19</ACSystemName>
<Deleted>true</Deleted>
<FacilityId>9f5b43ae-bc7d-4cb3-8cd7-edc6c7d09621</FacilityId>
<FacilityName>sample string 18</FacilityName>
<GroupHashTag>sample string 8</GroupHashTag>
<GuestCompanyName>sample string 7</GuestCompanyName>
<GuestEmail>sample string 5</GuestEmail>
<GuestFirstName>sample string 3</GuestFirstName>
<GuestLastName>sample string 4</GuestLastName>
<GuestPersonId>bed1281b-1b2f-4b58-9868-203bcd3e389b</GuestPersonId>
<GuestPhone>sample string 6</GuestPhone>
<HostCompanyName>sample string 17</HostCompanyName>
<HostEmail>sample string 15</HostEmail>
<HostFirstName>sample string 13</HostFirstName>
<HostLastName>sample string 14</HostLastName>
<HostPersonId>7050748b-a50e-4864-8450-6a505bc4f467</HostPersonId>
<HostPhone>sample string 16</HostPhone>
<Message>sample string 10</Message>
<RequestedAccessLevel>
<ACSystemId>ba019853-803b-4af8-8511-c3b1d2ad2aa2</ACSystemId>
<AccessLevelEndDate>2025-10-12T01:44:07.2342294+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-10-12T01:44:07.2342294+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>448ce9aa-7a41-447a-9cf2-778edf540778</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</RequestedAccessLevel>
<VisitationPattern>sample string 9</VisitationPattern>
<VisitorRequestId>02d60727-576b-43a4-a6e9-a46c643fe6f7</VisitorRequestId>
<VisitorTypeId>0d166597-08ac-4602-8ea6-809824b11f89</VisitorTypeId>
</VisitorViewModel>
</ArrayOfVisitorViewModel>