GET /visits/{visitID}

Retrieve a visit by its ID.

Path parameters

  • visitID integer Required

Responses

  • 200 application/json

    Visit details

    Hide response attributes Show response attributes object
    • visitID integer
    • startDate string(date-time)
    • endDate string(date-time)
    • isAllDay boolean
    • jobID integer
    • companyID integer
    • createdBy integer
    • updatedBy integer
  • 404

    Visit not found

  • 500

    Error occurred while retrieving the visit

GET /visits/{visitID} 
curl \
 -X GET http://api.example.com/visits/{visitID}
Response examples (200) 
{
  "visitID": 42,
  "startDate": "2024-05-04T09:42:00+00:00",
  "endDate": "2024-05-04T09:42:00+00:00",
  "isAllDay": true,
  "jobID": 42,
  "companyID": 42,
  "createdBy": 42,
  "updatedBy": 42
}