Developers API reference Phone Phone ring groups API REST endpoints for phone ring groups in ServFlo: 4 operations with parameters, request and response fields, permissions and curl examples.
Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication ); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id .
GET /organizations/{organizationId}/phone/ring-groups
Who rings for a call: office users answering in the browser and / or forwarded mobile numbers, all at once, optionally for one business unit. Read-only.
Permission phone.read (Owner, Admin, Dispatcher, Member)Risk read, OAuth scope servflo.read. Read: reads only.MCP tool phoneRingGroups_list (toolset marketing)
curl "https://app.servflo.ai/api/organizations/ $ORGANIZATION_ID /phone/ring-groups" \ -H "Authorization: Bearer $SERVFLO_API_KEY " 200: the answer's fields Field Type Description itemsarray of object items[].idstring items[].namestring items[].businessUnitIdstring or null items[].userIdsarray of string items[].forwardNumbersarray of string items[].ringTimeoutSecondsinteger or null items[].createdAtstring (date-time) items[].updatedAtstring (date-time)
POST /organizations/{organizationId}/phone/ring-groups
A ring group of office users (members whose role answers calls) and / or forward numbers. The first one becomes the default for numbers without their own group. 409 on a duplicate name.
Permission phone.manage (Owner, Admin)Risk write, OAuth scope servflo.write. Write: creates or changes records inside the business; nothing leaves it.MCP tool phoneRingGroups_create (toolset marketing)Plan Needs the Phone system add-on.
Field Type Required Description namestring Yes Up to 80 characters. businessUnitIdstring or null No userIdsarray of string No Office users (members with phone access) who answer in the browser. Up to 25 items. forwardNumbersarray of string No Up to 5 items. ringTimeoutSecondsinteger or null No 5–60.
curl -X POST "https://app.servflo.ai/api/organizations/ $ORGANIZATION_ID /phone/ring-groups" \ -H "Authorization: Bearer $SERVFLO_API_KEY " \ -H "Content-Type: application/json" \ -d '{"name":"Dana Whitfield"}' 201: the answer's fields Field Type Description idstring namestring businessUnitIdstring or null userIdsarray of string forwardNumbersarray of string ringTimeoutSecondsinteger or null createdAtstring (date-time) updatedAtstring (date-time)
PATCH /organizations/{organizationId}/phone/ring-groups/{ringGroupId}
Change who rings, forward numbers, the unit or the timeout, from the next call.
Permission phone.manage (Owner, Admin)Risk write, OAuth scope servflo.write. Write: creates or changes records inside the business; nothing leaves it.MCP tool phoneRingGroups_update (toolset marketing)Plan Needs the Phone system add-on.
Name In Type Required Description ringGroupIdpath string Yes
Field Type Required Description namestring No Up to 80 characters. businessUnitIdstring or null No userIdsarray of string No Office users (members with phone access) who answer in the browser. Up to 25 items. forwardNumbersarray of string No Up to 5 items. ringTimeoutSecondsinteger or null No 5–60.
curl -X PATCH "https://app.servflo.ai/api/organizations/ $ORGANIZATION_ID /phone/ring-groups/{ringGroupId}" \ -H "Authorization: Bearer $SERVFLO_API_KEY " \ -H "Content-Type: application/json" \ -d '{"name":"Dana Whitfield","businessUnitId":"businessUnit_id","userIds":["user_id"]}' 200: the answer's fields Field Type Description idstring namestring businessUnitIdstring or null userIdsarray of string forwardNumbersarray of string ringTimeoutSecondsinteger or null createdAtstring (date-time) updatedAtstring (date-time)
DELETE /organizations/{organizationId}/phone/ring-groups/{ringGroupId}
Destructive: numbers using it fall back to the default group (or voicemail). 409 while a menu still uses it.
Permission phone.manage (Owner, Admin)Risk sensitive, OAuth scope servflo.sensitive. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.MCP tool phoneRingGroups_delete (toolset marketing)Approval Over MCP, this tool always waits for your approval in ServFlo. See Approvals .
Name In Type Required Description ringGroupIdpath string Yes
curl -X DELETE "https://app.servflo.ai/api/organizations/ $ORGANIZATION_ID /phone/ring-groups/{ringGroupId}" \ -H "Authorization: Bearer $SERVFLO_API_KEY " 200: the answer's fields Field Type Description oktrue
