FunnelsList Funnels

List Funnels

List saved funnels.

curl -X GET "https://api.beacon.hard.al/v1/funnels?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "items": [
      {
        "funnelId": "c41d9f0a-3b76-4e21-a5c8-9e2f7d1b6a34",
        "funnelName": "Checkout funnel",
        "tenantId": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10",
        "sourceId": "7b0e5a54-1d43-4c8e-8d2f-5a9c3e6b1f27",
        "createdAt": "2026-09-15T08:30:00.000Z",
        "updatedAt": "2026-09-15T08:30:00.000Z",
        "steps": [
          {
            "stepOrder": 1,
            "stepType": "page",
            "stepValue": "/pricing"
          },
          {
            "stepOrder": 2,
            "stepType": "event",
            "stepValue": "add_to_cart"
          },
          {
            "stepOrder": 3,
            "stepType": "event",
            "stepValue": "purchase"
          }
        ],
        "breakdowns": [
          {
            "breakdownKey": "channel",
            "breakdownLabel": "Channel"
          }
        ]
      }
    ],
    "total": 1
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}
GET
/v1/funnels
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth access token (token exchange) or organization API key.

OAuth access token (token exchange) or organization API key.
query
tenantIdstring
Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

Format: uuid
query
sourceIdstring

Return the funnels saved for this source. Omit it to return the funnels that are not tied to one source.

Format: uuid
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth access token (token exchange) or organization API key.

Query Parameters

tenantIdstring
Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

sourceIdstring

Return the funnels saved for this source. Omit it to return the funnels that are not tied to one source.

Responses

successboolean
Required
Allowed values:true
dataobject
Required
timestampstring
Required
pathstring
Required
requestIdstring
Required