---
title: "Get batch operation status"
method: GET
path: "/accounts/{accountId}/access-widget-licenses/batch/{batchId}"
---

# Get batch operation status

`GET /accounts/{accountId}/access-widget-licenses/batch/{batchId}`

## Request

- Base URL: `https://dashboard.accessibe.com/api/v1/partners`
- URL: `https://dashboard.accessibe.com/api/v1/partners/accounts/{accountId}/access-widget-licenses/batch/{batchId}`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/accessibe/apis/partners-api-license/docs/accounts/:accountId/access-widget-licenses/batch/:batchId/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets the status of a batch operation for creating or updating accessWidget licenses. Use the batchId from the response of either POST /accounts/{accountId}/access-widget-licenses/batch-create or POST /accounts/{accountId}/access-widget-licenses/batch-update.

This endpoint requires the `x-api-key` header for authentication. The key must match the API key associated with the specified account. The account must also be a partner account.

## Path parameters

- `accountId` string, required

## Query parameters

- `batchId` string, required

## Response `200`

Batch operation found

- object
  - `success` boolean
  - `data` GetBatchStatus
    - `batchId` string
    - `hasErrors` boolean
    - `operation` 'create' | 'update'
    - `status` 'processing' | 'completed'
    - `successLicenses` object[]
      - `domain` string
      - `getLicenseURL` string
      - `licenseId` string
    - `failedLicenses` object[]
      - `domain` string
      - `message` string
    - `total` integer: The total number given in the request
    - `totalFailures` integer
    - `totalSuccesses` integer

## Other responses

- `202`: Batch operation is being processed
- `400`: The request is invalid. Any field could potentially be the cause.
- `401`: Missing or invalid API key
- `403`: Account does not have access to do this operation
- `404`: Batch operation not found

---

[API](https://skmtc.dev/accessibe/apis/partners-api-license.md) - [All operations](https://skmtc.dev/accessibe/apis/partners-api-license/llms.txt) - [OpenAPI document](https://skmtc.dev/accessibe/apis/partners-api-license/revisions/b7f155181cf7?raw)
