List Visit Types

๐Ÿงพ List Visit Types

Endpoint: GET /api/v3/visit-types

Auth Required: โœ… Yes (Bearer Token)


๐Ÿ“ Description

Returns the list of visit types configured in the system. Visit types classify the format or purpose of a visit, such as โ€œIn-Person Briefing,โ€ โ€œVirtual Meeting,โ€ or โ€œExecutive Tour.โ€ Useful for form selections and scheduling logic.


๐Ÿ” Query Parameters

Parameter Type Required Default Description
languageId integer No โ€” ID for localized visit type labels.

๐Ÿ“ค Request Example

GET https://api.briefingedge.com/api/v3/visit-types?languageId=1 Authorization: Bearer <token>  

โœ… Success Response (200 OK)

Returns an array of VisitType objects.

Example:

[  {    "VisitTypeID": 1,    "Name": "Executive Briefing",    "IsActive": true  },  {    "VisitTypeID": 2,    "Name": "Virtual Meeting",    "IsActive": true  } ]  

โŒ Error Responses

Code Message Description
401 Unauthorized Missing or invalid bearer token.
500 Internal Server Error Unexpected server-side failure.