API reference › Notifications › Role event trigger notifications

Get all role event trigger notifications

GET /v1/settings/role-event-trigger-notifications

Scope
settings_notifications_preferences:read
Roles
admin, scheduler

Retrieves all role event trigger notifications with search, filtering, and pagination support

Parameters

Query parameters

NameTypeDescription
searchstring

Search term to filter notifications by role name

Example Admin.

startDatestring (date)

Start date for filtering (YYYY-MM-DD)

Example 2025-01-01.

endDatestring (date)

End date for filtering (YYYY-MM-DD)

Example 2025-12-31.

sortBystring

Field to sort by

Example created_at.

sortOrderstring

Sort order (asc or desc)

One of: asc, desc. Example desc.

perPageinteger

Number of items per page

Example 10.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/role-event-trigger-notifications" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Successful operation

Successful operation

JSON
{
  "success": true,
  "data": [
    {
      "id": 1,
      "roleId": 1,
      "role": {
        "id": 2,
        "name": "Admin",
        "slug": "admin"
      },
      "inApp": true,
      "email": true,
      "sms": true,
      "canOverride": true
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 5,
    "perPage": 10,
    "total": 50
  }
}
Response fields (17)
FieldTypeDescription
successboolean

Example true.

dataarray of object
data[].idinteger

Example 1.

data[].roleIdinteger

Example 1.

data[].roleobject
data[].role.idinteger

Example 2.

data[].role.namestring

Example Admin.

data[].role.slugstring

Example admin.

data[].inAppboolean

Example true.

data[].emailboolean

Example true.

data[].smsboolean

Example true.

data[].canOverrideboolean

Example true.

metaobject
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 5.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 50.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.