GET api/v1/VisitorRequests?HostId={HostId}
Returns a list of VisitorViewModels going to see a particular Host that the API token has rights to view
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| HostId | 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": "56b01726-0372-4775-8b2f-8150f48c62db",
"GuestPersonId": "7e362b49-41a0-4bdb-9082-f043f0268fe4",
"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": "d1702809-1c47-4848-8085-1cb6186d0ddd",
"HostPersonId": "3002e4aa-109c-431c-b276-001ddddfa3a9",
"HostFirstName": "sample string 13",
"HostLastName": "sample string 14",
"HostEmail": "sample string 15",
"HostPhone": "sample string 16",
"HostCompanyName": "sample string 17",
"FacilityId": "f13c46ec-6a68-4e3e-817a-f32fa706892d",
"FacilityName": "sample string 18",
"ACSystemId": "b18ab014-c55f-4209-b71d-23f209c85416",
"ACSystemName": "sample string 19",
"RequestedAccessLevel": {
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2025-12-11T06:59:17.298843+00:00",
"AccessLevelEndDate": "2025-12-11T06:59:17.298843+00:00",
"Deleted": true,
"ACSystemId": "132c6202-95c7-47d1-8be0-ba2ca710a63a",
"CompanyId": "a4d67eac-c270-4086-a63c-89461e0b2c79",
"ApplyByDefault": true,
"AccessLevelTypeId": "3248b5bf-955f-4b24-8f3a-0cb66baf4fd3",
"FacilityId": "013eab20-dd33-4bab-b060-4ffea1a703b4"
},
"Deleted": true
},
{
"VisitorRequestId": "56b01726-0372-4775-8b2f-8150f48c62db",
"GuestPersonId": "7e362b49-41a0-4bdb-9082-f043f0268fe4",
"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": "d1702809-1c47-4848-8085-1cb6186d0ddd",
"HostPersonId": "3002e4aa-109c-431c-b276-001ddddfa3a9",
"HostFirstName": "sample string 13",
"HostLastName": "sample string 14",
"HostEmail": "sample string 15",
"HostPhone": "sample string 16",
"HostCompanyName": "sample string 17",
"FacilityId": "f13c46ec-6a68-4e3e-817a-f32fa706892d",
"FacilityName": "sample string 18",
"ACSystemId": "b18ab014-c55f-4209-b71d-23f209c85416",
"ACSystemName": "sample string 19",
"RequestedAccessLevel": {
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2025-12-11T06:59:17.298843+00:00",
"AccessLevelEndDate": "2025-12-11T06:59:17.298843+00:00",
"Deleted": true,
"ACSystemId": "132c6202-95c7-47d1-8be0-ba2ca710a63a",
"CompanyId": "a4d67eac-c270-4086-a63c-89461e0b2c79",
"ApplyByDefault": true,
"AccessLevelTypeId": "3248b5bf-955f-4b24-8f3a-0cb66baf4fd3",
"FacilityId": "013eab20-dd33-4bab-b060-4ffea1a703b4"
},
"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>b18ab014-c55f-4209-b71d-23f209c85416</ACSystemId>
<ACSystemName>sample string 19</ACSystemName>
<Deleted>true</Deleted>
<FacilityId>f13c46ec-6a68-4e3e-817a-f32fa706892d</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>7e362b49-41a0-4bdb-9082-f043f0268fe4</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>3002e4aa-109c-431c-b276-001ddddfa3a9</HostPersonId>
<HostPhone>sample string 16</HostPhone>
<Message>sample string 10</Message>
<RequestedAccessLevel>
<ACSystemId>132c6202-95c7-47d1-8be0-ba2ca710a63a</ACSystemId>
<AccessLevelEndDate>2025-12-11T06:59:17.298843+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-12-11T06:59:17.298843+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>a4d67eac-c270-4086-a63c-89461e0b2c79</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</RequestedAccessLevel>
<VisitationPattern>sample string 9</VisitationPattern>
<VisitorRequestId>56b01726-0372-4775-8b2f-8150f48c62db</VisitorRequestId>
<VisitorTypeId>d1702809-1c47-4848-8085-1cb6186d0ddd</VisitorTypeId>
</VisitorViewModel>
<VisitorViewModel>
<ACSystemId>b18ab014-c55f-4209-b71d-23f209c85416</ACSystemId>
<ACSystemName>sample string 19</ACSystemName>
<Deleted>true</Deleted>
<FacilityId>f13c46ec-6a68-4e3e-817a-f32fa706892d</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>7e362b49-41a0-4bdb-9082-f043f0268fe4</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>3002e4aa-109c-431c-b276-001ddddfa3a9</HostPersonId>
<HostPhone>sample string 16</HostPhone>
<Message>sample string 10</Message>
<RequestedAccessLevel>
<ACSystemId>132c6202-95c7-47d1-8be0-ba2ca710a63a</ACSystemId>
<AccessLevelEndDate>2025-12-11T06:59:17.298843+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-12-11T06:59:17.298843+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>a4d67eac-c270-4086-a63c-89461e0b2c79</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</RequestedAccessLevel>
<VisitationPattern>sample string 9</VisitationPattern>
<VisitorRequestId>56b01726-0372-4775-8b2f-8150f48c62db</VisitorRequestId>
<VisitorTypeId>d1702809-1c47-4848-8085-1cb6186d0ddd</VisitorTypeId>
</VisitorViewModel>
</ArrayOfVisitorViewModel>