Skip to main content
POST
/
api
/
v1
/
signal
Get Signal
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/signal/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "signal_id": 123,
  "filters": {
    "date_from": "<string>",
    "date_to": "<string>"
  }
}
'
{
  "signal_id": 123,
  "signal_name": "<string>",
  "total_accounts": 123,
  "total_people": 123,
  "signal_type": "<string>",
  "status": "<string>",
  "repeat": true,
  "icp": {
    "id": 123,
    "name": "<string>",
    "target_roles": [
      "<string>"
    ],
    "min_employee": 123,
    "max_employee": 123,
    "min_funding": "<string>",
    "max_funding": "<string>",
    "location": [
      "<string>"
    ],
    "sub_locations": [
      "<string>"
    ],
    "people_locations": [
      "<string>"
    ],
    "people_sub_locations": [
      "<string>"
    ]
  },
  "account_ids": [],
  "signal_people": [
    {
      "person_id": 123,
      "person_name": "<string>",
      "person_role": "<string>",
      "person_email": "<string>",
      "person_location": "<string>",
      "person_linkedin_url": "<string>",
      "joined_company_at": "<string>",
      "person_crm_status": "<string>",
      "person_salesforce_contact_id": "<string>",
      "person_salesforce_owner_id": "<string>",
      "person_team_name": "<string>",
      "account_id": 123,
      "account_name": "<string>",
      "account_domain": "<string>",
      "direct_signals": [
        {}
      ]
    }
  ]
}

Headers

X-API-Key
string
required
X-User-ID
string
required

Body

application/json
signal_id
integer
required

Signal ID to get details for

filters
GetSignalFilters · object

Optional filters to apply when querying signals. All filters are combined with AND logic.

Response

Successful Response

signal_id
integer
required
signal_name
string
required
total_accounts
integer
required
total_people
integer
required
signal_type
string | null
status
string | null

Signal processing status. Poll until value is completed to know when results are ready.

repeat
boolean | null

Run Daily toggle. If true, this signal runs automatically every day. Can be true, false, or null.

icp
SignalICP · object

ICP (Ideal Customer Profile) associated with this signal. Only non-null fields are returned.

account_ids
integer[]
signal_people
SignalPeople · object[] | null