Get a signal setup

Retrieves one signal setup by ID.

Use the id returned by List signal setups or Set up a signal. This ID is specific to your environment.

Route

GET/api/v3/signal-setups/{id}

Access modes

Use a workspace API key. The workspace is inferred from the key.

Authorization: Bearer sk_live_...

Path parameters

Parameter	Type	Description
id	integer	ID of the signal setup, from the list or create endpoint. Specific to your environment.

Example request

curl "https://api.getsillage.com/api/v3/signal-setups/42" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Success response

Status: 200 OK

{
  "data": {
    "id": 42,
    "signal_template_id": 3,
    "name": "Acme keywords",
    "status": "enabled",
    "parameters": { "keywords": ["acme"], "scopes": ["discovery"] },
    "schedule": null,
    "created_at": "2026-09-18T12:00:00.000Z"
  }
}

Response fields

Field	Type	Description
data.id	integer	ID of the signal setup. Specific to your environment.
data.signal_template_id	integer	ID of the signal this setup is for.
data.name	string	Display name for this setup.
data.status	string	`enabled` or `disabled`.
data.parameters	object	This setup's own answers, exactly as sent.
data.schedule	object or null	`null`, or `{ "cadence": "weekly" }` when this setup runs on its own.
data.created_at	string	When this setup was created.

Errors

Status	Meaning
400	`id` is not a valid ID.
401	The API key is missing or invalid.
404	No signal setup matches this ID.
429	Rate limit exceeded.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank on v3 — title is what tells one problem from another:

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Signal setup 99999 not found",
  "instance": "/api/v3/signal-setups/99999"
}