List ring groups

GET/api/v1/domains/{domain_uuid}/ring-groups

Find your company’s ring groups.

Path parameters

domain_uuidstringrequired

Your company ID supplied by Junction Cloud Connections. Use the same ID throughout your requests.

Query parameters

limitinteger

Optional. Number of results to return (min 1, max 100). Defaults to 50.

starting_afterstring

Optional. Return results after this ring group UUID (cursor).

Responses

200Success

objectstring

urlstring

has_moreboolean

dataarray[object]

Show nested fields

ring_group_uuidstring

objectstring

domain_uuidstring

ring_group_namestring

ring_group_extensionstring

ring_group_enabledboolean

ring_group_descriptionstring

400Invalid starting_after UUID

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

404Domain not found

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

REQUEST EXAMPLE

Replace the host, token and example IDs with your account details.

curl --request GET \
  --url "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/ring-groups?limit=25" \
  --header "Authorization: Bearer $JUNCTIONCC_API_TOKEN" \
  --header "Accept: application/json"

const token = process.env.JUNCTIONCC_API_TOKEN;

const response = await fetch("https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/ring-groups?limit=25", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`,
    Accept: "application/json"
  }
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const text = await response.text();
console.log(text ? JSON.parse(text) : null);

import json
import os
from urllib.request import Request, urlopen

request = Request(
    "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/ring-groups?limit=25",
    method="GET",
    headers={
        "Authorization": "Bearer " + os.environ["JUNCTIONCC_API_TOKEN"],
        "Accept": "application/json"
    }
)
with urlopen(request, timeout=30) as response:
    body = response.read()
    print(json.loads(body) if body else None)

RESPONSE EXAMPLE

{
  "object": "list",
  "url": "/api/v1/domains/4018f7a3-8e0a-47bb-9f4f-04b1313e0e1b/ring-groups",
  "has_more": true,
  "data": [
    {
      "ring_group_uuid": "c0ec8113-aa15-40ac-8437-47185dd9dcf4",
      "object": "ring_group",
      "domain_uuid": "4018f7a3-8e0a-47bb-9f4f-04b1313e0e1b",
      "ring_group_name": "Sales Ring Group",
      "ring_group_extension": "9000",
      "ring_group_enabled": true,
      "ring_group_description": null
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid starting_after UUID.",
    "code": "invalid_request",
    "param": "starting_after"
  }
}

{
  "error": {
    "type": "authentication_error",
    "message": "Unauthenticated.",
    "code": "unauthenticated"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Domain not found.",
    "code": "resource_missing",
    "param": "domain_uuid"
  }
}