hog_flows

get/api/projects/{project_id}/hog_flows/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_flows/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

broadcast_eligibleboolean

Pass true to return broadcasts plus the ordinary workflows the broadcasts UI can render: a batch trigger and a single email step.

broadcast_statusstring

Comma-separated broadcast statuses as the broadcasts UI shows them: draft, scheduled, sending, sent, failed, archived. Scheduled, sending, sent and failed come from the latest run and whether a schedule still has sends to come.

created_atstring date-time
created_bystring uuid

Filter to workflows created by the user with this uuid.

idstring uuid
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

optimization_enabledboolean

Only workflows someone turned suggestions on for.

origin_product'broadcasts' | 'loops'

Filter to workflows owned by a product surface, e.g. loops for Desktop loops.

searchstring

Case-insensitive search. Matches workflow name and description first; only when nothing matches those, it matches step names and the subject line, preheader and body text of email steps, in both the live workflow and its pending draft.

status'active' | 'archived' | 'draft'
  • draft - Draft
  • active - Active
  • archived - Archived
triggerstring

Filter by trigger config as a JSON object. Returns workflows whose trigger contains the given object, e.g. {"type": "event"}.

typestring

Comma-separated workflow types. loop and broadcast return the workflows those surfaces own; messaging returns the remaining workflows with an email, SMS, or push action, and automation the rest.

updated_atstring date-time

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

No recorded changes to this operation across all 1 revision of this API.