API reference › Broadcast and dispatch › Rate based broadcasts

Retrieve a rate based broadcast by ID

GET /v1/rate-based-broadcasts/{rate_based_broadcast}

Scope
settings_broadcast_dispatch:read
Roles
admin, scheduler

Fetch a rate based broadcast by its ID.

Parameters

Path parameters

NameTypeDescription
rate_based_broadcast requiredinteger

ID of the rate-based broadcast to retrieve.

Example 10.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/rate-based-broadcasts/{rate_based_broadcast}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Rate based broadcast retrieved successfully

Rate based broadcast retrieved successfully.

JSON
{
  "success": true,
  "message": "Rate based broadcast retrieved successfully!",
  "data": {
    "id": 1,
    "rate": 0,
    "cycleInterval": 1,
    "cycleIntervalUnit": "minutes"
  }
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Rate based broadcast retrieved successfully!.

dataobject
data.idinteger

Example 1.

data.ratenumber

Example 0.

data.cycleIntervalinteger or null

Example 1.

data.cycleIntervalUnitstring or null

Example minutes.

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_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 .

404 Not found

Rate based broadcast not found.

JSON
{
  "success": false,
  "message": "Rate based broadcast with ID 10 not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Rate based broadcast with ID 10 not found..

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": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.