Menu

Rules

1 endpoint in the Mattering Networking API.

GETPOST rules/ User APIService tier

List rules, or create one with POST. derived from route

This read is not paginated. It returns at most 300 rows and does not report a total, so a result of exactly 300 may be truncated.

URL

  • User APIhttps://networking.mattering.io/api/user/v1/rules/
  • Service tierhttps://networking.mattering.io/api/internal/v1/rules/

Query parameters

NameDefault
settingnone
spacenone

Responses

200 data and meta envelope

{
  "data": [
    {
      "id": "...",
      "setting": "...",
      "phase": "...",
      "text": "...",
      "why": "...",
      "order": 0,
      "is_active": true,
      "confidence": "...",
      "due_at": "2026-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "count": 0
  }
}

200 data and meta envelope

{
  "data": {
    "id": "...",
    "setting": "...",
    "phase": "...",
    "text": "...",
    "why": "...",
    "order": 0,
    "is_active": true,
    "confidence": "...",
    "due_at": "2026-01-01T00:00:00Z"
  }
}

200 data and meta envelope

{
  "data": {
    "deleted": "..."
  }
}

201 data and meta envelope

{
  "data": {
    "id": "...",
    "setting": "...",
    "phase": "...",
    "text": "...",
    "why": "...",
    "order": 0,
    "is_active": true,
    "confidence": "...",
    "due_at": "2026-01-01T00:00:00Z"
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400bad_action
400validation
401unauthorized
404not_found

Example

curl -X GET "https://networking.mattering.io/api/user/v1/rules/?setting=...&space=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: NetworkingCore/internal_api.py (internal_api.rules_collection)

All Networking resources
Start Free Explore our Products