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

NameTypeDescription
searchstring

Search by role name

Example Admin.

startDatestring (date)

Filter by start date (YYYY-MM-DD)

Example 2024-01-01.

endDatestring (date)

Filter by end date (YYYY-MM-DD)

Example 2024-12-31.

sortBystring

Sort by field

Example created_at.

sortOrderstring

Sort order (asc/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/default-access-setting" \
  -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"
      },
      "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.

FieldTypeDescription
successboolean

Example true.

dataarray of object (14 nested)
metaobject (4 nested)

Nested fields

data 14 fields
FieldTypeDescription
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[].portalAccessboolean

Example true.

data[].networkEnabledboolean

Example true.

data[].shareWithinOrganizationboolean

Example true.

data[].createAssignmentRequestboolean

Example true.

data[].viewManageFinancesboolean

Example true.

data[].createAssignmentboolean

Example true.

data[].createdAtstring

Example 2026-01-15.

data[].updatedAtstring

Example 2026-01-15.

meta 4 fields
FieldTypeDescription
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.