List Engagement Types

๐Ÿงพ List Engagement Types

Endpoint: GET /api/v3/engagement-types

Auth Required: โœ… Yes (Bearer Token)


๐Ÿ“ Description

Fetches the list of engagement types used in visit planning and reporting. Engagement types define the nature of a visit, such as "Executive Briefing," "Workshop," or "Webinar." This list supports UI elements like dropdowns and filters.


๐Ÿ” Query Parameters

Parameter Type Required Default Description
includeInactive boolean No false If true, includes inactive engagement types.
languageId integer No 1 Language ID for localized type names.

๐Ÿ“ค Request Example

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

โœ… Success Response (200 OK)

Returns an array of EngagementType objects.

Example:

[  {    "EngagementTypeID": 1,    "Name": "Executive Briefing",    "IsActive": true  },  {    "EngagementTypeID": 2,    "Name": "Workshop",    "IsActive": true  } ]  

โŒ Error Responses

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