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": "6c3888ae-a351-451a-b160-c9ad7cc5162a",
"GuestPersonId": "bc4ae0f4-30dd-4732-8a76-95b31ff81b68",
"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": "dafbf753-ea5b-41b3-add1-8ca685658f68",
"HostPersonId": "26f93abe-4a24-455b-9af9-a7efb35665a5",
"HostFirstName": "sample string 13",
"HostLastName": "sample string 14",
"HostEmail": "sample string 15",
"HostPhone": "sample string 16",
"HostCompanyName": "sample string 17",
"FacilityId": "73d98ab8-4f8d-41d9-bb37-f6e22138ce1e",
"FacilityName": "sample string 18",
"ACSystemId": "2f7e3e40-a552-452c-8d3f-9233b5fa3c83",
"ACSystemName": "sample string 19",
"RequestedAccessLevel": {
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2025-12-01T12:13:23.5608307+00:00",
"AccessLevelEndDate": "2025-12-01T12:13:23.5608307+00:00",
"Deleted": true,
"ACSystemId": "f7b11190-9067-4628-af3f-7a0095d4ecb9",
"CompanyId": "3bc12ee8-b3ed-4047-8371-71c00e48f195",
"ApplyByDefault": true,
"AccessLevelTypeId": "e8942689-96b9-460a-89c9-fd35be553a41",
"FacilityId": "6fa4bf05-55e2-43b6-8d44-dca0f69a20ea"
},
"Deleted": true
},
{
"VisitorRequestId": "6c3888ae-a351-451a-b160-c9ad7cc5162a",
"GuestPersonId": "bc4ae0f4-30dd-4732-8a76-95b31ff81b68",
"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": "dafbf753-ea5b-41b3-add1-8ca685658f68",
"HostPersonId": "26f93abe-4a24-455b-9af9-a7efb35665a5",
"HostFirstName": "sample string 13",
"HostLastName": "sample string 14",
"HostEmail": "sample string 15",
"HostPhone": "sample string 16",
"HostCompanyName": "sample string 17",
"FacilityId": "73d98ab8-4f8d-41d9-bb37-f6e22138ce1e",
"FacilityName": "sample string 18",
"ACSystemId": "2f7e3e40-a552-452c-8d3f-9233b5fa3c83",
"ACSystemName": "sample string 19",
"RequestedAccessLevel": {
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2025-12-01T12:13:23.5608307+00:00",
"AccessLevelEndDate": "2025-12-01T12:13:23.5608307+00:00",
"Deleted": true,
"ACSystemId": "f7b11190-9067-4628-af3f-7a0095d4ecb9",
"CompanyId": "3bc12ee8-b3ed-4047-8371-71c00e48f195",
"ApplyByDefault": true,
"AccessLevelTypeId": "e8942689-96b9-460a-89c9-fd35be553a41",
"FacilityId": "6fa4bf05-55e2-43b6-8d44-dca0f69a20ea"
},
"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>2f7e3e40-a552-452c-8d3f-9233b5fa3c83</ACSystemId>
<ACSystemName>sample string 19</ACSystemName>
<Deleted>true</Deleted>
<FacilityId>73d98ab8-4f8d-41d9-bb37-f6e22138ce1e</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>bc4ae0f4-30dd-4732-8a76-95b31ff81b68</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>26f93abe-4a24-455b-9af9-a7efb35665a5</HostPersonId>
<HostPhone>sample string 16</HostPhone>
<Message>sample string 10</Message>
<RequestedAccessLevel>
<ACSystemId>f7b11190-9067-4628-af3f-7a0095d4ecb9</ACSystemId>
<AccessLevelEndDate>2025-12-01T12:13:23.5608307+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-12-01T12:13:23.5608307+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>3bc12ee8-b3ed-4047-8371-71c00e48f195</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</RequestedAccessLevel>
<VisitationPattern>sample string 9</VisitationPattern>
<VisitorRequestId>6c3888ae-a351-451a-b160-c9ad7cc5162a</VisitorRequestId>
<VisitorTypeId>dafbf753-ea5b-41b3-add1-8ca685658f68</VisitorTypeId>
</VisitorViewModel>
<VisitorViewModel>
<ACSystemId>2f7e3e40-a552-452c-8d3f-9233b5fa3c83</ACSystemId>
<ACSystemName>sample string 19</ACSystemName>
<Deleted>true</Deleted>
<FacilityId>73d98ab8-4f8d-41d9-bb37-f6e22138ce1e</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>bc4ae0f4-30dd-4732-8a76-95b31ff81b68</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>26f93abe-4a24-455b-9af9-a7efb35665a5</HostPersonId>
<HostPhone>sample string 16</HostPhone>
<Message>sample string 10</Message>
<RequestedAccessLevel>
<ACSystemId>f7b11190-9067-4628-af3f-7a0095d4ecb9</ACSystemId>
<AccessLevelEndDate>2025-12-01T12:13:23.5608307+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-12-01T12:13:23.5608307+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>3bc12ee8-b3ed-4047-8371-71c00e48f195</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</RequestedAccessLevel>
<VisitationPattern>sample string 9</VisitationPattern>
<VisitorRequestId>6c3888ae-a351-451a-b160-c9ad7cc5162a</VisitorRequestId>
<VisitorTypeId>dafbf753-ea5b-41b3-add1-8ca685658f68</VisitorTypeId>
</VisitorViewModel>
</ArrayOfVisitorViewModel>