API reference › Broadcast and dispatch › Broadcast settings

Retrieve broadcast & dispatch logic settings

GET /v1/settings/broadcast-settings

Scope
settings_broadcast_dispatch:read
Roles
admin, scheduler

Fetches broadcast & dispatch logic settings

Parameters

None of its own.

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

Example request

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

Try it

Responses

200 Broadcast & Dispatch Logic settings retrieved successfully

Broadcast & Dispatch Logic settings retrieved successfully

JSON
{
  "success": true,
  "data": {
    "id": 1,
    "initialProviderPoolSize": 1,
    "cycleInterval": 1,
    "cycleIntervalUnit": "minutes",
    "maximumBroadcastRounds": 1,
    "maximumTotalProvidersContracted": 1,
    "repeatContactProviderHoursLimit": 1,
    "autoEscalateAfterFailedRounds": 1,
    "enableBroadcastDefault": true,
    "enableFidoNetworkBroadcastDefault": true,
    "enableRotationalBroadcast": true,
    "enablePriorityBasedBroadcastBehavior": true,
    "enableRateBaseBehavior": true,
    "userTieredMatchingPools": true,
    "enableProfitabilityBasedMatching": true,
    "expressInterests": true,
    "whoConfirmsAssignments": "string",
    "notifySchedulerOnExpressedInterest": true,
    "notifyClientOnExpressedInterest": true,
    "acceptAction": true,
    "whoConfirmsAcceptedAssignments": "string",
    "notifySchedulerOnAcceptedAssignments": true,
    "notifyClientOnAcceptedAssignments": true,
    "declineAction": true,
    "declineTimeframe": 1,
    "declineTimeframeUnit": "string",
    "autoFillDelay": true,
    "autoFillDelayTimeframe": 1,
    "autoFillDelayTimeframeUnit": "string",
    "providerResponseWindow": true,
    "providerResponseWindowTimeframe": 1,
    "providerResponseWindowUnit": "string",
    "noProviderResponseNotifyScheduler": true,
    "noProviderResponseNotifySchedulerAfter": 1,
    "noProviderResponseNotifySchedulerAfterUnit": "string",
    "autoEscalateUnfilled": true,
    "autoEscalateUnfilledAfter": 1,
    "autoEscalateUnfilledAfterUnit": "string",
    "notifyUrgentGaps": true,
    "urgentGapsStartIn": 1,
    "urgentGapsStartInUnit": "string",
    "enableEscalationLogic": true,
    "escalateStillUnfilledAfter": 1,
    "escalateStillUnfilledAfterUnit": "string",
    "escalationNotifyMethodEmail": true,
    "escalationNotifyMethodSms": true,
    "escalationNotifyMethodInapp": true,
    "allowManualOverride": true,
    "triggerImmediateRebroadcast": true,
    "notifySchedulerInstantly": true,
    "markAssignmentsAtRisk": true,
    "broadcastPriorityOrder": {
      "id": "string",
      "label": "Example label",
      "order": 1
    },
    "rotationalBroadcastPrioritizations": [],
    "escalationNotifyUsers": "string"
  }
}
Response fields (59)

2 top-level fields; 1 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

dataobject (57 nested)

Nested fields

data 57 fields
FieldTypeDescription
data.idinteger

Example 1.

data.initialProviderPoolSizeinteger

Example 1.

data.cycleIntervalinteger

Example 1.

data.cycleIntervalUnitstring

Example minutes.

data.maximumBroadcastRoundsinteger

Example 1.

data.maximumTotalProvidersContractedinteger

Example 1.

data.repeatContactProviderHoursLimitinteger

Example 1.

data.autoEscalateAfterFailedRoundsinteger

Example 1.

data.enableBroadcastDefaultboolean

Example true.

data.enableFidoNetworkBroadcastDefaultboolean

Example true.

data.enableRotationalBroadcastboolean

Example true.

data.enablePriorityBasedBroadcastBehaviorboolean

Example true.

data.enableRateBaseBehaviorboolean

Example true.

data.userTieredMatchingPoolsboolean

Example true.

data.enableProfitabilityBasedMatchingboolean

Example true.

data.expressInterestsboolean

Example true.

data.whoConfirmsAssignmentsstring

Example string.

data.notifySchedulerOnExpressedInterestboolean

Example true.

data.notifyClientOnExpressedInterestboolean

Example true.

data.acceptActionboolean

Example true.

data.whoConfirmsAcceptedAssignmentsstring

Example string.

data.notifySchedulerOnAcceptedAssignmentsboolean

Example true.

data.notifyClientOnAcceptedAssignmentsboolean

Example true.

data.declineActionboolean

Example true.

data.declineTimeframeinteger

Example 1.

data.declineTimeframeUnitstring

Example string.

data.autoFillDelayboolean

Example true.

data.autoFillDelayTimeframeinteger

Example 1.

data.autoFillDelayTimeframeUnitstring

Example string.

data.providerResponseWindowboolean

Example true.

data.providerResponseWindowTimeframeinteger

Example 1.

data.providerResponseWindowUnitstring

Example string.

data.noProviderResponseNotifySchedulerboolean

Example true.

data.noProviderResponseNotifySchedulerAfterinteger

Example 1.

data.noProviderResponseNotifySchedulerAfterUnitstring

Example string.

data.autoEscalateUnfilledboolean

Example true.

data.autoEscalateUnfilledAfterinteger

Example 1.

data.autoEscalateUnfilledAfterUnitstring

Example string.

data.notifyUrgentGapsboolean

Example true.

data.urgentGapsStartIninteger

Example 1.

data.urgentGapsStartInUnitstring

Example string.

data.enableEscalationLogicboolean

Example true.

data.escalateStillUnfilledAfterinteger

Example 1.

data.escalateStillUnfilledAfterUnitstring

Example string.

data.escalationNotifyMethodEmailboolean

Example true.

data.escalationNotifyMethodSmsboolean

Example true.

data.escalationNotifyMethodInappboolean

Example true.

data.allowManualOverrideboolean

Example true.

data.triggerImmediateRebroadcastboolean

Example true.

data.notifySchedulerInstantlyboolean

Example true.

data.markAssignmentsAtRiskboolean

Example true.

data.broadcastPriorityOrderobject
data.broadcastPriorityOrder.idstring

Example string.

data.broadcastPriorityOrder.labelstring

Example Example label.

data.broadcastPriorityOrder.orderinteger

Example 1.

data.rotationalBroadcastPrioritizationsarray of object
data.escalationNotifyUsersstring

Example string.

401 Not signed in

Unauthorized - authentication required

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_broadcast_dispatch: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_broadcast_dispatch: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.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..