Skip to main content
GET
/
routers
/
{routerId}
Get router by id
curl --request GET \
  --url https://api.routera.io/routers/{routerId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Contact Router",
  "object_type": "contacts",
  "has_integration": true,
  "is_published": true,
  "archived": false,
  "created_at": "2026-05-01T10:00:00.000Z",
  "updated_at": "2026-05-28T12:00:00.000Z",
  "settings": {
    "overwrite": true,
    "owner_field": "contact_owner",
    "distribution_model": "round robin",
    "default_user": "developer@test.com",
    "disable_default_assignment": false,
    "ignore_working_hours": true,
    "account_matching": true,
    "trigger": {
      "groups": [
        {
          "conditions": []
        }
      ]
    }
  },
  "users": [
    {
      "email": "user@example.com"
    }
  ],
  "teams": [
    {
      "name": "Sales Team"
    }
  ]
}

Endpoint

GET https://api.routera.io/routers/{routerId}
Route: /routers/{routerId}
Authentication: Bearer JWT

Path parameters

ParameterRequiredDescription
routerIdYesRouter UUID

Response

200 — Router object (same shape as list items)
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Contact Router",
  "object_type": "contacts",
  "has_integration": true,
  "is_published": true,
  "archived": false,
  "created_at": "2026-05-01T10:00:00.000Z",
  "updated_at": "2026-05-28T12:00:00.000Z",
  "settings": {
    "overwrite": true,
    "owner_field": "contact_owner",
    "distribution_model": "round robin",
    "default_user": "developer@test.com",
    "disable_default_assignment": false,
    "ignore_working_hours": true,
    "account_matching": true,
    "trigger": {
      "groups": [
        {
          "conditions": []
        }
      ]
    }
  },
  "users": [
    {
      "email": "user@example.com"
    }
  ],
  "teams": [
    {
      "name": "Sales Team"
    }
  ]
}

Settings mapping

Setting keyAPI value
overwriteboolean
owner_fieldfield internal name string
distribution_model"round robin" or "percentage"
default_userbackup user email
disable_default_assignmentboolean
ignore_working_hoursboolean
account_matchingboolean
rotation_typestring
triggerJSON object (only setting returned as JSON)

Errors

StatusWhen
400Invalid or missing routerId (not a UUID)
401Missing or invalid account context in JWT
404Router not found for this account
500Internal server error

Authorizations

Authorization
string
header
required

Bearer JWT with valid account context.

Path Parameters

routerId
string
required

Object identifier

Response

Router

Router configuration with flattened settings. Only trigger may be a JSON object.

id
string
name
string
object_type
string
has_integration
boolean
is_published
boolean
created_at
string<date-time>
updated_at
string<date-time>
archived

false when active, or ISO timestamp when archived

archived_by
string

Present when archived

settings
object

Flattened settings keyed by setting_id (overwrite, owner_field, distribution_model, etc.)

users
object[]
teams
object[]