Sign in
Sequences

Get recipient detail

Returns instance state and event timeline. Requires a USER API key.

get/public/v1/sequences/{sequenceId}/recipients/{instanceId}

Path parameters

sequenceIdnumber nullable
Example:101
instanceIdnumber nullable
Example:9001

Response

Recipient detail

completedNodeIdsstring[] required
snapshotMode'PINNED' | 'LEGACY' | 'MISSING' required
stepsMode'GRAPH_TOPOLOGICAL' required
exitNotestring nullable required
exitedAtstring nullable required
lastActivityAtstring nullable required
nextActionLabelstring nullable required

Example response

{
  "instance": {
    "id": 1,
    "accountId": 1,
    "sequenceId": 1,
    "personRowId": "example",
    "snapshotId": "example",
    "sourceSnapshotId": "example",
    "snapshotPinnedAt": "example",
    "currentNodeId": "example",
    "status": "ACTIVE",
    "blockedOn": "NONE",
    "nextExecutionAt": "example",
    "enrolledByUserId": 1,
    "senderConnectedAccountId": 1,
    "startedAt": "example",
    "lastAdvancedAt": "example",
    "exitedAt": "example",
    "completedAt": "example",
    "pausedAt": "example",
    "removedAt": "example",
    "exitReason": "example",
    "exitNote": "example",
    "exitedByUserId": 1,
    "failureReason": "example",
    "failureCode": "example",
    "createdAt": "example",
    "updatedAt": "example",
    "enrolledByUser": {
      "id": 1,
      "firstName": "example",
      "lastName": "example",
      "email": "user@example.com",
      "avatar": "example"
    },
    "exitedByUser": {
      "id": 1,
      "firstName": "example",
      "lastName": "example",
      "email": "user@example.com",
      "avatar": "example"
    }
  },
  "person": {
    "rowId": "example",
    "fullName": "example",
    "email": "example",
    "avatar": "example"
  },
  "steps": [
    {
      "nodeId": "example",
      "alias": "example",
      "workflowId": "example",
      "name": "example",
      "position": {
        "positionX": 1,
        "positionY": 1
      },
      "type": "TRIGGER_INTENT",
      "handles": [
        {
          "handleId": "example",
          "sourceEdge": {
            "from": "example",
            "fromHandleId": "example",
            "to": "example",
            "toHandleId": "example"
          },
          "text": "example"
        }
      ],
      "targetEdges": [
        {
          "from": "example",
          "fromHandleId": "example",
          "to": "example",
          "toHandleId": "example"
        }
      ],
      "data": {
        "type": "RESPONSE_AI",
        "assistantId": "example",
        "aiModelId": 1,
        "model": "example",
        "aiVendor": "OPENAI",
        "instructions": "example",
        "temperature": 1,
        "exitNodeWhen": "ALL_VARIABLES",
        "knowledgeBaseMode": "DEFAULT",
        "knowledgeBaseIds": [
          1
        ]
      },
      "createdAt": "example",
      "updatedAt": "example"
    }
  ],
  "completedNodeIds": [
    "example"
  ],
  "events": [
    {
      "id": 1,
      "type": "ENROLLED",
      "nodeId": "example",
      "createdAt": "example"
    }
  ],
  "timeline": [
    {
      "nodeId": "example",
      "label": "example",
      "events": [
        {
          "id": "example",
          "source": "lifecycle",
          "type": "example",
          "sequenceInstanceId": 1,
          "sequenceMessageId": 1,
          "messageRef": "example",
          "nodeId": "example",
          "channel": "EMAIL",
          "occurredAt": "example",
          "messagePreview": {
            "subject": "example",
            "snippet": "example",
            "bodyHtml": "example"
          }
        }
      ]
    }
  ],
  "historySteps": [
    {
      "nodeId": "example",
      "label": "example",
      "type": "example",
      "alias": "example",
      "name": "example",
      "status": "COMPLETED",
      "pathLabel": "example",
      "preview": {
        "subject": "example",
        "snippet": "example"
      },
      "trackingSummaries": [
        {
          "type": "EMAIL_OPENED",
          "messageRef": "example",
          "sequenceMessageId": 1,
          "nodeId": "example",
          "firstOpenedAt": "example",
          "lastOpenedAt": "example",
          "count": 1,
          "rawEventIds": [
            "example"
          ],
          "classification": {
            "values": [
              "human"
            ]
          },
          "occurrences": [
            {
              "occurredAt": "example"
            }
          ]
        }
      ],
      "compactEvents": [
        {
          "id": "example",
          "source": "lifecycle",
          "type": "example",
          "sequenceInstanceId": 1,
          "sequenceMessageId": 1,
          "messageRef": "example",
          "nodeId": "example",
          "channel": "EMAIL",
          "occurredAt": "example",
          "messagePreview": {
            "subject": "example",
            "snippet": "example",
            "bodyHtml": "example"
          }
        }
      ],
      "events": [
        {
          "id": "example",
          "source": "lifecycle",
          "type": "example",
          "sequenceInstanceId": 1,
          "sequenceMessageId": 1,
          "messageRef": "example",
          "nodeId": "example",
          "channel": "EMAIL",
          "occurredAt": "example",
          "messagePreview": {
            "subject": "example",
            "snippet": "example",
            "bodyHtml": "example"
          }
        }
      ]
    }
  ],
  "globalEvents": [
    {
      "id": "example",
      "source": "lifecycle",
      "type": "example",
      "sequenceInstanceId": 1,
      "sequenceMessageId": 1,
      "messageRef": "example",
      "nodeId": "example",
      "channel": "EMAIL",
      "occurredAt": "example",
      "messagePreview": {
        "subject": "example",
        "snippet": "example",
        "bodyHtml": "example"
      }
    }
  ],
  "snapshotMode": "PINNED",
  "stepsMode": "GRAPH_TOPOLOGICAL",
  "enrolledByUser": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "avatar": "example"
  },
  "lastFailure": {
    "nodeId": "example",
    "nodeType": "example",
    "attemptNumber": 1,
    "errorCode": "example",
    "occurredAt": "example"
  },
  "exitReason": {
    "code": "example",
    "label": "example"
  },
  "exitNote": "example",
  "exitedAt": "example",
  "exitedBy": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "avatar": "example"
  },
  "lastActivityAt": "example",
  "nextActionLabel": "example"
}

Changes

Changed in 1 of the 2 revisions of this API.1