hog_flows

List the scheduled sends for the send calendar

Changed on

Active batch and schedule workflows with an email step that is not transactional, and that have a schedule with sends to come or a batch run inside the range. Each carries only the fields a calendar card shows. Read a single workflow for its full configuration.

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_flows/send_calendar/
  • 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

endstring date-time required

End of the shown range, exclusive, as an ISO 8601 datetime. At most 92 days after start.

startstring date-time required

Start of the shown range, inclusive, as an ISO 8601 datetime.

Response

idstring uuid required

ID of the workflow.

namestring nullable required

Name of the workflow.

user_access_levelstring nullable required

The reader's access level on the workflow.

trigger_typestring required

The trigger type: batch or schedule.

audience_propertiesobject[] required

The property filters of a batch trigger's audience. Empty for a schedule trigger.

audience_typestring nullable required

persons or accounts for a batch trigger's audience. Null when the trigger does not set it.

email_tostring nullable required

The 'To' address of the first email step. A schedule trigger has no audience, so it sends here.

message_category_idstring nullable required

ID of the message category of the first email step.

Changes