Automations

List the contacts currently at one node

Only contacts with status "running" or "paused" ("paused" means waiting at a delay node - pauseUntil says when it continues). Pass "trigger" as currentNodeId (instead of a real node _id) to list contacts who have been enrolled but haven't reached the first node yet.

get/v1/projectId/{projectId}/automations/{automationId}/running-nodes/{currentNodeId}

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/automations/{automationId}/running-nodes/{currentNodeId}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

automationIdstring required
currentNodeIdstring required

A node _id from the automation's sequence, or the literal string "trigger".

Query parameters

limitinteger

Max items per page. Capped at 30.

skipinteger

Number of items to skip, for pagination.

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

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