Get batch

Gets a resource by ID.

get

Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.

Path parameters

idstringRequired

The resource ID.

Query parameters

selectstringOptional

Optional RQL select statement to filter fields.

Responses

200

OK

application/json

Represents a batch of notification messages that share common properties.

idstringOptional

revisioninteger · int32Optional

bodystring · nullableOptional

Gets or sets the body content for messages in this batch.

subjectstringOptional

Gets or sets the subject for messages in this batch.

statusstringOptional

Gets or sets the current status of the batch.

statusReasonstring · nullableOptional

Gets or sets the reason for the current status of the batch.

typestringOptional

Gets or sets the type of batch.

payloadstring · nullableOptional

Gets or sets the payload data used for template-based batches.

sendContextstringOptional

Gets or sets the send context of the batch.

400

Bad Request

application/json

404

Not Found

application/json

get/public/v1/notifications/batches/{id}

HTTPcURLJavaScriptPython

GET /public/v1/notifications/batches/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-07-20T23:38:13.470Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-20T23:38:13.470Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "completed": {
      "at": "2026-07-20T23:38:13.470Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "processed": {
      "at": "2026-07-20T23:38:13.470Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "attachments": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "fileName": "text",
      "fileSize": 1,
      "contentType": "text"
    }
  ],
  "body": "text",
  "category": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "published": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "unpublished": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "deleted": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "revision": 1,
    "description": "text",
    "optOutAllowed": true,
    "status": "text",
    "note": "text",
    "deleteAllowed": true,
    "statistics": {
      "month": 1,
      "today": 1,
      "week": 1
    },
    "lastUsed": "2026-07-20T23:38:13.470Z",
    "enabledByDefault": true
  },
  "template": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "activated": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "deleted": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "disabled": {
        "at": "2026-07-20T23:38:13.470Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "revision": 1,
    "category": {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "lastUsed": "2026-07-20T23:38:13.470Z"
    },
    "criteria": {
      "accountTypes": [
        "text"
      ],
      "filterCondition": "text",
      "objectType": "text",
      "recipients": {
        "selector": "text"
      }
    },
    "defaultVariant": {
      "id": "text",
      "revision": 1,
      "default": true,
      "languageCode": "text",
      "status": "text"
    },
    "description": "text",
    "lastUsed": "2026-07-20T23:38:13.470Z",
    "owner": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active"
    },
    "statistics": {
      "month": 1,
      "today": 1,
      "week": 1
    },
    "status": "text",
    "variants": [
      {
        "id": "text",
        "revision": 1,
        "default": true,
        "languageCode": "text",
        "status": "text"
      }
    ],
    "externalId": "text"
  },
  "statistics": {
    "bounced": 1,
    "complained": 1,
    "discarded": 1,
    "failed": 1,
    "queued": 1,
    "sent": 1,
    "total": 1
  },
  "subject": "text",
  "status": "text",
  "statusReason": "text",
  "type": "text",
  "payload": "text",
  "sendContext": "text",
  "sourceAccount": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  }
}