Get Batch Result
GET /v2/batch/operations/{id}/result
Required scopes
batch:operations:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getBatchResult |
| Tags | Batch |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | schema | |
| include_all | query | boolean | Return full result detail (e.g., contacts_created_ids without truncation) |
| include | query | string | incoming_webhooks.replay: per-row lineage report |
Responses
200
Per-operation result shape. Discriminated union over BatchResult variants
per 04-batch.md §3.12: ContactsUpsertResult, AccountsUpsertResult,
EngagementBackfillResult, MessagesSendResult, JourneysEnrollCohortResult,
JourneysBulkCancelResult, CohortsMaterializeResult,
CohortsMaterializeToAudienceResult, ObjectivesBulkCompleteResult,
WebhooksBulkReplayResult, IncomingWebhooksReplayResult.
object
| Field | Type | Description |
|---|---|---|
| kind * | schema |
Example request
GET https://api.digitalonboarding.com/v2/batch/operations/{id}/result?<query-params>
Authorization: Bearer <partner-token>