Skip to content

List channel profiles

GET/omnichannel/channel-profiles

Returns all channel profiles for the tenant, each representing a named queue with routing and capacity configuration. Use to populate profile selector dropdowns in conversation creation forms or settings pages.

Request

This endpoint takes no parameters and no request body.

Responses

200 List of channel profiles

Content type application/json, array of object · OmnichannelChannelProfileV1.

FieldTypeRequiredDescription
idintegerNo

Auto-incremented primary key.

namestringNo

Human-readable display name for the profile.

channelstringNo

The channel type this profile handles.

One of: "email", "web_chat", "sms", "whatsapp", "voice", "social", "internal"

channel_config_idinteger, nullableNo

ID of the underlying channel adapter configuration.

queue_namestring, nullableNo

Queue identifier used by the routing engine.

routing_modestringNo

Algorithm used to distribute conversations to agents.

One of: "capacity", "priority", "round_robin"

default_prioritystringNo

Default priority assigned to conversations routed through this profile.

One of: "low", "normal", "high", "urgent"

workload_capacityintegerNo

Maximum number of simultaneous conversations an agent in this queue can handle.

Minimum: 1 · Maximum: 500

quality_thresholdnumber (float)No

Minimum quality score (0-100) before a conversation is flagged for review.

Minimum: 0 · Maximum: 100

supervisor_user_idinteger, nullableNo

ID of the user who supervises this queue.

is_activebooleanNo

Whether this profile is currently accepting conversations.

Example

[
  {
    "id": 3,
    "name": "Enterprise Email Support",
    "channel": "email",
    "queue_name": "enterprise_email",
    "routing_mode": "round_robin",
    "default_priority": "high",
    "workload_capacity": 30,
    "quality_threshold": 85.0,
    "is_active": true,
    "supervisor_user_id": 2
  }
]

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/omnichannel/channel-profiles" \
  -H "Accept: application/json"
Loading