Skip to main content
POST
/
api
/
v1
/
signal
/
get-signal-list
List Signals
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/signal/get-signal-list \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "filters": {
    "signal_types": [
      "hiring"
    ]
  },
  "pagination": {
    "limit": 50,
    "offset": 0
  }
}
'
{
  "signals": [
    {
      "signal_id": 123,
      "signal_name": "<string>",
      "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>"
        ]
      }
    }
  ],
  "total_count": 123,
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total_count": 123,
    "has_more": true
  }
}

Headers

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

Body

application/json
​
filters
SignalFilters · object

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

​
pagination
PaginationParams · object

Pagination parameters for the request

Response

Successful Response

Paginated response for signal list.

​
signals
Signal · object[]
required
​
total_count
integer
required
​
pagination
PaginationMetadata · object

Pagination metadata (included when pagination is requested)