---
title: "Retrieve bulk team operation status"
method: GET
path: "/v2/teams/bulk/status/{id}"
tags: ["BulkTeamOperations"]
---

# Retrieve bulk team operation status

`GET /v2/teams/bulk/status/{id}`

This endpoint retrieves the status of a bulk team operation using its bulk ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval. Use this endpoint to check the progress and completion status of bulk update operations.

## Path parameters

- `id` string, required

## Query parameters

- `pageToken` string
- `pageSize` string, int64
- `status` string

## Response `200`

Details of the bulk operation status and progress.

- V2BulkTeamStatusResponse
  - `bulkId` string — Unique identifier for the bulk operation.
  - `resource` 'BULK_OPERATION_RESOURCE_BILLING' | 'BULK_OPERATION_RESOURCE_CAMPAIGN' | 'BULK_OPERATION_RESOURCE_AUTH'
  - `operationType` 'BULK_OPERATION_TYPE_CAMPAIGN_UPDATE' | 'BULK_OPERATION_TYPE_CAMPAIGN_STATE_UPDATE' | 'BULK_OPERATION_TYPE_WALLET_UPDATE' | 'BULK_OPERATION_TYPE_TEAM_UPDATE' | 'BULK_OPERATION_TYPE_WALLET_CREATE' | 'BULK_OPERATION_TYPE_TEAM_CREATE' | 'BULK_OPERATION_TYPE_CAMPAIGN_CREATE' | 'BULK_OPERATION_TYPE_INVITE_USER' | 'BULK_OPERATION_TYPE_REMOVE_USER'
  - `status` 'BULK_OPERATION_SUBMITTED' | 'BULK_OPERATION_IN_PROGRESS' | 'BULK_OPERATION_COMPLETED' | 'BULK_OPERATION_FAILED'
  - `totalCount` string, int64 — Total number of items in the bulk operation.
  - `successCount` string, int64 — Number of items processed successfully.
  - `failureCount` string, int64 — Number of items that failed processing.
  - `createdAt` string, date-time — Timestamp when the bulk operation was created.
  - `updatedAt` string, date-time — Timestamp when the bulk operation was last updated.
  - `items` Citrusauthv2BulkOperationItem[]
    - `status` 'BULK_ITEM_SUCCESS' | 'BULK_ITEM_FAILED'
    - `successResponse` Citrusauthv2SuccessResponse
      - `teamId` string — The unique identifier of the team that was processed.
      - `message` string — Success message for the operation.
    - `errorResponse` V1ErrorResponse
      - `details` string — Error details describing what went wrong during the operation.
    - `createTeamRequest` Authv3Team
      - `id` string, required — The team's unique ID number.
      - `name` string, required — The name of the team.
      - `namespaceId` string, required — The organization or account group ID.
      - `companyName` string, required — The name of the company to which the team belongs.
      - `companyWebsite` string — The company website URL.
      - `companyPhone` string — The company phone number.
      - `companyAddress` Authv3CompanyAddress
        - `addressLine` string — The business street address.
        - `postcode` string — The business postal or ZIP code.
      - `companyType` 'COMPANY_TYPE_RETAILER' | 'COMPANY_TYPE_MANUFACTURER', required
      - `industryType` 'INDUSTRY_TYPE_GROCERY' | 'INDUSTRY_TYPE_PHARMACEUTICALS' | 'INDUSTRY_TYPE_PET_SUPPLIES' | 'INDUSTRY_TYPE_LIQUOR' | 'INDUSTRY_TYPE_ELECTRONICS' | 'INDUSTRY_TYPE_HARDWARE' | 'INDUSTRY_TYPE_FASHION' | 'INDUSTRY_TYPE_OTHER', required
      - `logoId` string — The company logo ID.
      - `businessIdentifier` string — The business registration number or license ID (requirements vary by country).
      - `reviewerEmail` string — The email address to be notified when a campaign requires review or when there is information about a low wallet balance. This field is applicable only to the Primary Retailer team.
      - `sellerId` string — The unique seller ID provided by the retailer.
      - `modifyTime` string, date-time — The timestamp indicating when the team was last modified.
      - `onBehalfOf` string — Specifies the entity responsible for funding advertisements, as required by local laws, such as the Digital Services Act in Europe.
    - `updateTeamRequest` Authv2UpdateTeam
      - `id` string, required — The unique identifier of the team.
      - `name` string — The name of the team.
      - `namespaceId` string — The unique identifier of the namespace.
      - `companyName` string — The name of the company to which the team belongs.
      - `companyWebsite` string — The URL of the company's website.
      - `companyPhone` string — The phone number of the company to which the team belongs.
      - `companyAddress` Authv2CompanyAddress
        - `addressLine` string — The primary address line, typically including the street address.
        - `postcode` string — The postal code for the address.
      - `companyType` 'COMPANY_TYPE_RETAILER' | 'COMPANY_TYPE_MANUFACTURER'
      - `industryType` 'INDUSTRY_TYPE_GROCERY' | 'INDUSTRY_TYPE_PHARMACEUTICALS' | 'INDUSTRY_TYPE_PET_SUPPLIES' | 'INDUSTRY_TYPE_LIQUOR' | 'INDUSTRY_TYPE_ELECTRONICS' | 'INDUSTRY_TYPE_HARDWARE' | 'INDUSTRY_TYPE_FASHION' | 'INDUSTRY_TYPE_OTHER'
      - `businessIdentifier` string — A unique identifier used for various business-related purposes, such as a registration number, business license, or company house number. The specific identifier required may vary depending on the country or region where your company is located.
      - `reviewerEmail` string — The email address to be notified when a campaign requires review or when there is information about a low wallet balance. This field is applicable only to the Primary Retailer team..
      - `logoId` string — A unique identifier for the logo associated with the team.
      - `sellerId` string — A unique identifier for a supplier or merchant, issued by a Retailer. Ensure that the entered ID matches the one provided by your retailer.
      - `modifyTime` string, date-time — The timestamp indicating when the team was last modified.
      - `onBehalfOf` string — Specifies the entity responsible for funding advertisements, as required by local laws, such as the Digital Services Act in Europe.
    - `inviteUserRequest` V2InviteTeam
      - `managerTeamId` string — The unique identifier of the retailer team. The retailer team handles access management and can send invitations to users, including suppliers.
      - `roleIds` Authv2RoleTypes[], required — The team permissions. Users can be assigned either retailer or supplier permissions: - Retailer full: Provides users full access, allowing them to modify administration settings, campaigns, reviews, team manager roles, and team settings. - Retailer report view: Provides users with read only access to dashboards, campaigns, and reporting data. - Supplier full: Provides users full access, allowing them to modify administration settings, campaigns, and team settings. - Supplier report view: Provides users with read only access to dashboards, campaigns, and reporting data.
      - `teamId` string, required — A unique identifier for the team linked to the user who will receive the invitation.
      - `emailToInvite` string, required — The email address of the user who will be invited to join the team.
      - `inviteUrl` string — The base invitation url emailed to the user to respond to their invitation and continue the onboarding process.
      - `languageCode` 'EN_US' | 'CS_CZ' | 'FR_FR' | 'HU_HU' | 'IT_IT' | 'JA_JP' | 'KO_KR' | 'PT_BR' | 'SK_SK' | 'ES_ES' — Language code as per ISO 639-1 format.
    - `removeUserRequest` V2QuitTeamRequest
      - `teamId` string, required — A unique identifier for the team linked to the user.
      - `userId` string, required — The unique identifier of the user.
  - `nextPageToken` string — Token to retrieve the next page of results.

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Access denied due to insufficient permissions.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/revisions/a040003c7378/schema)