API reference › Notifications › Role event trigger notifications
Get role event trigger notification by ID
GET /v1/settings/role-event-trigger-notifications/{id}
- Scope
settings_notifications_preferences:read- Roles
- admin, scheduler
Retrieves a specific role event trigger notification by its ID
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | integer | Role event trigger notification ID Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/role-event-trigger-notifications/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Successful operation
Successful operation
{
"success": true,
"message": "Role event trigger notification retrieved successfully.",
"data": {
"id": 1,
"roleId": 1,
"role": {
"id": 2,
"name": "Admin",
"slug": "admin"
},
"inApp": true,
"email": true,
"sms": true,
"canOverride": true
}
}Response fields (13)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.roleId | integer | Example |
data.role | object | |
data.role.id | integer | Example |
data.role.name | string | Example |
data.role.slug | string | Example |
data.inApp | boolean | Example |
data.email | boolean | Example |
data.sms | boolean | Example |
data.canOverride | boolean | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
404 Not found
Role event trigger notification not found
{
"success": false,
"message": "Role event trigger notification not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |