API reference › Notifications › Default access setting
Get all default access settings
GET /v1/settings/default-access-setting
- Scope
settings_notifications_preferences:read- Roles
- admin, scheduler
Retrieves a paginated list of default access settings with search and filtering capabilities
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search by role name Example |
startDate | string (date) | Filter by start date (YYYY-MM-DD) Example |
endDate | string (date) | Filter by end date (YYYY-MM-DD) Example |
sortBy | string | Sort by field Example |
sortOrder | string | Sort order (asc/desc) One of: |
perPage | integer | Number of items per page Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/default-access-setting" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Successful operation
Successful operation
{
"success": true,
"data": [
{
"id": 1,
"roleId": 1,
"role": {
"id": 2,
"name": "Admin",
"slug": "admin"
},
"portalAccess": true,
"networkEnabled": true,
"shareWithinOrganization": true,
"createAssignmentRequest": true,
"viewManageFinances": true,
"createAssignment": true,
"createdAt": "2026-01-15",
"updatedAt": "2026-01-15"
}
],
"meta": {
"currentPage": 1,
"lastPage": 5,
"perPage": 10,
"total": 50
}
}Response fields (21)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (14 nested) | |
meta | object (4 nested) |
Nested fields
data 14 fields
| Field | Type | Description |
|---|---|---|
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[].portalAccess | boolean | Example |
data[].networkEnabled | boolean | Example |
data[].shareWithinOrganization | boolean | Example |
data[].createAssignmentRequest | boolean | Example |
data[].viewManageFinances | boolean | Example |
data[].createAssignment | boolean | Example |
data[].createdAt | string | Example |
data[].updatedAt | string | Example |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | 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 |
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: |