.png){kind=logo}
Visit Details
Description
This endpoint retrieves visit details along with the details of all related entities.
HTTP Method
get
URL
/api/v2/v2visits/{visitID}
Path Parameters
| Name | Type |
|---|---|
| visitID | required <integer> |
Query Parameters
| Name | Type | Description |
|---|---|---|
| LanguageId | optional <integer> | Language ID for localized content. |
| IncludeSite | optional <boolean> | Include site information in the response. Default: false |
| IncludeEngagementType | optional <boolean> | Include engagement type details. Default: false |
| IncludeVisitStatus | optional <boolean> | Include visit status details. Default: false |
| IncludeVisitType | optional <boolean> | Include visit type details. Default: false |
| IncludeCoordinators | optional <boolean> | Include coordinator details. Default: false |
| IncludeCoordinatorRoles | optional <boolean> | Include coordinator roles details. Default: false |
| IncludeRequester | optional <boolean> | Include requester details. Default: false |
| IncludeOwners | optional <boolean> | Include owner details. Default: false |
| IncludeSalesChannels | optional <boolean> | Include sales channels details. Default: false |
| IncludeVisitDays | optional <boolean> | Include visit days details. Default: false |
| IncludeVisitRooms | optional <boolean> | Include visit rooms details. Default: false |
| IcludeAgendaItems | optional <boolean> | Include agenda details. Default: false |
| IncludeTopics | optional <boolean> | Include topic details. Default: false |
| IncludeMeals | optional <boolean> | Include meals details. Default: false |
| IncludeTopicCategories | optional <boolean> | Include topic categories details. Default: false |
| IncludeSpeakers | optional <boolean> | Include speakers details. Default: false |
| IncludeAttendees | optional <boolean> | Include attendees details. Default: false |
| IncludeCustomers | optional <boolean> | Include customers details. Default: false |
| IncludeOpportunities | optional <boolean> | Include opportunities details. Default: false |
| IncludeCustomerQuestions | optional <boolean> | Include customer questions details. Default: false |
| IncludeReasons | optional <boolean> | Include reason for visit details. Default: false |
| IncludeLogistics | optional <boolean> | Include logistics details. Default: false |
| IncludeExtraInfo | optional <boolean> | Include extra info details. Default: false |
| IncludeDocuments | optional <boolean> | Include document details. Default: false |
Response & Example
Success Response
Code: 200 OK