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. |