API reference › General settings › Communication modes

Retrieve all communication modes or filter by tenant ID

GET /v1/communication-modes

Scope
settings_general:read

Fetch a list of all communication modes or filter by a specific tenant ID if provided.

Parameters

Query parameters

NameTypeDescription
tenantIdstring

Tenant ID for filtering.

Example demotenant.

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

Example request

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

Try it

Responses

200 Communication modes retrieved successfully

Communication modes retrieved successfully.

JSON
{
  "success": true,
  "message": "Communication Modes Retrieved!",
  "data": [
    {
      "id": 1,
      "value": 1,
      "label": "Example label",
      "isCustom": true
    }
  ]
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Communication Modes Retrieved!.

dataarray of object
data[].idinteger

Example 1.

data[].valueinteger

Example 1.

data[].labelstring

Example Example label.

data[].isCustomboolean

Example true.

400 Bad request

Invalid argument provided.

JSON
{
  "success": false,
  "message": "Failed to retrieve."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

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

Example false.

messagestring

Example Something went wrong!.