List Attendee Roles
๐งพ List Attendee Roles
Endpoint: GET /api/v3/attendee-roles
Auth Required: โ Yes (Bearer Token)
๐ Description
Retrieves a list of attendee roles available in the system. These roles are commonly used to define participantsโ functions during a visit, such as Speaker, Host, or Guest. Useful when populating dropdowns or role-based logic in interfaces.
๐ Query Parameters
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
includeInactive |
boolean | No | false | If true, includes inactive attendee roles. |
languageId |
integer | No | 1 | ID of the language for localized role names. |
๐ค Request Example
GET https://api.briefingedge.com/api/v3/attendee-roles?includeInactive=false&languageId=1 Authorization: Bearer <token>
โ Success Response (200 OK)
Returns an array of AttendeeRole
objects.
Example:
[ { "RoleID": 1, "Name": "Speaker", "IsActive": true }, { "RoleID": 2, "Name": "Guest", "IsActive": true } ]
โ Error Responses
Code | Message | Description |
---|---|---|
401 | Unauthorized | Missing or invalid bearer token. |
500 | Internal Server Error | Unexpected server-side failure. |