.png){kind=logo}
Visits (Get)
Description
This endpoint retrieves a list of visits along with their key details, including site, engagement type, visit type, and date.
HTTP Method
get
URL
/api/v2/v2visits
Query Parameters
Name |
Type |
Description |
|---|---|---|
| IncludeSite | optional <boolean> | Include site information in the response. Default: false |
| IncludeVisitStatus | optional <boolean> | Include visit status details. Default: false |
| IncludeVisitType | optional <boolean> | Include visit type details. Default: false |
| includeEngagementType | optional <boolean> | Include engagement type details. Default: false |
| StartsAt | optional <string> date-time | Retrieve visits that start on or after this timestamp (YYYY-MM-DDTHH:MM:SSZ). |
| EndsAt | optional <string> date-time | Retrieve visits that end on or before this timestamp (YYYY-MM-DDTHH:MM:SSZ). |
| UpdatedAfter | optional <string> date-time | Retrieve visits updated after this timestamp (YYYY-MM-DDTHH:MM:SSZ). |
| StatusIds | optional <integer> array |
Filter by visit status IDs (e.g., StatusIds=[1,2,3]). |
| SiteIds | optional <integer> array |
Filter by site IDs (e.g., SiteIds=[100,200]). |
| TypeIds | optional <integer> array |
Filter by visit type IDs. |
| languageID | optional<integer> | Language ID for localized content. |
| Limit | optional <integer> | Number of records per response. Default: 100 Max: 100 |
| Offset | optional <integer> | Pagination offset. Default: 0. |
| Order | optional <string> Available values : DESC, ASC |
Sort order (ASC or DESC). Default: ASC. |
| OrderBy | Available values : VisitStart, VisitName, VisitModifiedDate | Sorting field (VisitStart, VisitName, VisitModifiedDate). Default: VisitStart. |
Response
{
"Records": [
{
"VisitID": 0,
"VisitName": "string",
"VisitStatusID": 0,
"EngagementTypeID": 0,
"SiteID": 0,
"VisitTypeID": 0,
"EstimatedNumberOfAttendees": 0,
"TimezoneIndex": "string",
"TimezoneString": "string",
"VisitStart": "2025-02-10T11:01:06.932Z",
"VisitEnd": "2025-02-10T11:01:06.932Z",
"VisitRequestDate": "2025-02-10T11:01:06.932Z",
"VisitModifiedDate": "2025-02-10T11:01:06.932Z",
"IsConfidential": true,
"IsBusinessAttireRequired": true,
"WebinarLink": "string",
"WebinarInstructions": "string",
"WebinarLinkIsLocation": true,
"CRMInstanceID": 0,
"IncompleteExpirationNotificationSentDate": "2025-02-10T11:01:06.932Z",
"OffsiteLocation": "string",
"VisitPIN": "string",
"RequesterID": 0,
"SourceOfRequest": "string", // "External", "Internal User", "CRM", "Dynamics", "Salesforce"
"Site": {
"SiteID": 0,
"SiteName": "string",
"ContactInfo": "string",
"MaxVisitsPerDay": 0,
"isActive": true,
"DateLastUpdated": "2025-02-10T11:01:06.932Z",
"DateFormat": "string",
"TimeFormat": 0,
"MinimumVisitLength": 0,
"MaximumVisitLength": 0,
"SiteAddress": "string",
"ProgramName": "string",
"SiteCity": "string",
"SiteStateProvince": "string",
"SiteCountry": "string",
"SitePostalCode": "string",
"SiteRegionID": 0,
"SiteType": "string",
"TourSite": 0,
"Description": "string",
"BusinessUnitID": 0,
"SiteNameAbbr": "string",
"AllowWeekendVisits": true,
"AllowAMFullTopicsPage": true,
"ContractExpireDate": "2025-02-10T11:01:06.932Z",
"MinVisitStart": "string",
"MaxVisitEnd": "string",
"TimeZoneIndex": "string",
"TimeZoneName": "string",
"CustomerPortal_SiteName": "string",
"Notes": "string",
"RegionName": "string"
},
"Status": {
"StatusID": 0,
"IsActive": true,
"Name": "string"
},
"VisitType": {
"VisitTypeID": 0,
"VisitTypeName": "string",
"DisplayOrder": 0,
"SchedulingUse": 0,
"IsRoomRequired": true,
"IncludeInExecRpts": true,
"CountsTowardMax": true,
"IsTopicRequired": true,
"AllowMultiDay": true,
"CanStartOnHalfHour": true,
"AMCanPickVisitStartEnd": true,
"AllowAMTimeChangePage": true,
"DurationText": "string",
"NumMinutes": 0,
"Notes": "string",
"AddCustomerOptCode": 0,
"AddCustomerCRMOptCode": 0,
"AddCustAttendeeOptCode": 0,
"AddCustAttendeeCRMOptCode": 0,
"AddOpportunityOptCode": 0,
"AddOpportunityCRMOptCode": 0,
"AltDate1Code": 0,
"AltDate2Code": 0,
"AddInternalAttendeeOptCode": 0
},
"EngagementType": {
"EngagementTypeID": 0,
"EngagementTypeName": "string",
"IsActive": true,
"DisplayOrder": 0,
"Notes": "string"
}
}
],
"Metadata": {
"Limit": 0,
"Offset": 0,
"Total": 0,
"Links": {
"Self": "string",
"Previous": "string",
"Next": "string",
"First": "string",
"Last": "string"
}
}
}
Example
{
"Records": [
{
"VisitID": 12345,
"VisitName": "Tech Innovation Summit",
"VisitStatusID": 2,
"EngagementTypeID": 5,
"SiteID": 101,
"VisitTypeID": 3,
"EstimatedNumberOfAttendees": 50,
"TimezoneIndex": "Pacific Standard Time",
"TimezoneString": "PST",
"VisitStart": "2025-02-10T09:00:00.000Z",
"VisitEnd": "2025-02-10T12:00:00.000Z",
"VisitRequestDate": "2025-01-20T14:30:00.000Z",
"VisitModifiedDate": "2025-02-05T10:15:00.000Z",
"IsConfidential": false,
"IsBusinessAttireRequired": true,
"WebinarLink": "https://webinar.example.com/join",
"WebinarInstructions": "Join via the provided link 10 minutes before the start time.",
"WebinarLinkIsLocation": true,
"CRMInstanceID": 5678,
"IncompleteExpirationNotificationSentDate": "2025-02-07T08:00:00.000Z",
"OffsiteLocation": "San Francisco Conference Center",
"VisitPIN": "ABC123",
"RequesterID": 7890,
"SourceOfRequest": "Internal User", // "External", "Internal User", "CRM", "Dynamics", "Salesforce"
"Site": {
"SiteID": 101,
"SiteName": "Silicon Valley HQ",
"ContactInfo": "contact@svhq.com",
"MaxVisitsPerDay": 10,
"isActive": true,
"DateLastUpdated": "2025-01-30T12:45:00.000Z",
"DateFormat": "MM/dd/yyyy",
"TimeFormat": 24,
"MinimumVisitLength": 30,
"MaximumVisitLength": 240,
"SiteAddress": "123 Innovation Drive, San Jose, CA",
"ProgramName": "Tech Tours",
"SiteCity": "San Jose",
"SiteStateProvince": "California",
"SiteCountry": "USA",
"SitePostalCode": "95110",
"SiteRegionID": 7,
"SiteType": "Corporate",
"TourSite": 1,
"Description": "A leading technology innovation center",
"BusinessUnitID": 456,
"SiteNameAbbr": "SVHQ",
"AllowWeekendVisits": false,
"AllowAMFullTopicsPage": true,
"ContractExpireDate": "2026-12-31T00:00:00.000Z",
"MinVisitStart": "08:00",
"MaxVisitEnd": "18:00",
"TimeZoneIndex": "Pacific Standard Time",
"TimeZoneName": "PST",
"CustomerPortal_SiteName": "SVHQ Tech Tours",
"Notes": "Guests must check in at the reception.",
"RegionName": "West Coast"
},
"Status": {
"StatusID": 2,
"IsActive": true,
"Name": "Confirmed"
},
"VisitType": {
"VisitTypeID": 3,
"VisitTypeName": "Corporate Tour",
"DisplayOrder": 2,
"SchedulingUse": 1,
"IsRoomRequired": true,
"IncludeInExecRpts": true,
"CountsTowardMax": true,
"IsTopicRequired": true,
"AllowMultiDay": false,
"CanStartOnHalfHour": true,
"AMCanPickVisitStartEnd": true,
"AllowAMTimeChangePage": true,
"DurationText": "3 hours",
"NumMinutes": 180,
"Notes": "Includes a guided tour and Q&A session",
"AddCustomerOptCode": 1,
"AddCustomerCRMOptCode": 1,
"AddCustAttendeeOptCode": 1,
"AddCustAttendeeCRMOptCode": 1,
"AddOpportunityOptCode": 1,
"AddOpportunityCRMOptCode": 1,
"AltDate1Code": 0,
"AltDate2Code": 0,
"AddInternalAttendeeOptCode": 1
},
"EngagementType": {
"EngagementTypeID": 5,
"EngagementTypeName": "Executive Briefing",
"IsActive": true,
"DisplayOrder": 1,
"Notes": "High-level strategy discussions with executives"
}
}
],
"Metadata": {
"Limit": 100,
"Offset": 0,
"Total": 2000,
"Links": {
"Self": "api/v2/v2visits?limit=100&offset=0",
"Previous": null,
"Next": "/api/v2/v2visits?limit=100&offset=100",
"First": "/api/v2/v2visits?limit=100&offset=0",
"Last": "api/v2/v2visits?limit=100&offset=2300"
}
}
}
Success Response
Code: 200 OK