Signals

List Signal Rules

The workspace's trigger rules, oldest first.

API key access

Needs the leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/signal-rules
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/signal-rules" \  -H "X-Workspace-Id: string"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "name": "string",
      "enabled": true,
      "kinds": [
        "hiring"
      ],
      "keywords": [
        "string"
      ],
      "action": "notify",
      "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
      "max_leads": 0,
      "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
      "fired_count": 0,
      "last_fired_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}