---
title: "Get a job group in a batch"
method: GET
path: "/api/v1alpha/batches/{batch_id}/job-groups/{job_group_id}"
tags: ["Batches API v1Alpha"]
---

# Get a job group in a batch

`GET /api/v1alpha/batches/{batch_id}/job-groups/{job_group_id}`

## Request

- Base URL: `{{ base_url }}`
- URL: `{{ base_url }}/api/v1alpha/batches/{batch_id}/job-groups/{job_group_id}`
- Auth: none declared

Get a job group in a batch by ID.

## Path parameters

- `batch_id` number, required
- `job_group_id` number, required

## Response `200`

Successfully retrieved the job group in the batch.

- JobGroupDetailResponse
  - `batch_id` integer: ID of the batch this job group belongs to
  - `job_group_id` integer: The job group ID
  - `parent_job_group_id` integer, nullable: ID of the parent job group
  - `state` 'running' | 'complete' | 'cancelled': Current state of the job group
  - `complete` boolean: Whether the job group is complete
  - `n_jobs` integer: Total number of jobs in the group
  - `n_completed` integer: Number of completed jobs
  - `n_succeeded` integer: Number of succeeded jobs
  - `n_failed` integer: Number of failed jobs
  - `n_cancelled` integer: Number of cancelled jobs
  - `time_created` string, date-time: When the job group was created
  - `attributes` object: Key-value pairs of attributes for the job group
  - `children` JobGroupResponse[]: List of child job groups
    - `batch_id` integer: ID of the batch this job group belongs to
    - `job_group_id` integer: The job group ID
    - `state` 'running' | 'complete' | 'cancelled': Current state of the job group
    - `complete` boolean: Whether the job group is complete
    - `n_jobs` integer: Total number of jobs in the group
    - `n_completed` integer: Number of completed jobs
    - `n_succeeded` integer: Number of succeeded jobs
    - `n_failed` integer: Number of failed jobs
    - `n_cancelled` integer: Number of cancelled jobs
    - `time_created` string, date-time: When the job group was created
    - `attributes` object: Key-value pairs of attributes for the job group

## Changes

- **2025-04-16** `afa3b61d1d09`: 13 info
  - added the optional property `attributes` to the response with the `200` status
  - added the optional property `batch_id` to the response with the `200` status
  - added the optional property `children` to the response with the `200` status
  - added the optional property `complete` to the response with the `200` status
  - …9 more
- **2025-01-14** `559a91071cc1`: 13 warning
  - removed the optional property `attributes` from the response with the `200` status
  - removed the optional property `batch_id` from the response with the `200` status
  - removed the optional property `children` from the response with the `200` status
  - removed the optional property `complete` from the response with the `200` status
  - …9 more

[Operation history](https://skmtc.dev/hail-is/apis/hail-services/changes/api/v1alpha/batches/:batch_id/job-groups/:job_group_id/get.md)

---

[API](https://skmtc.dev/hail-is/apis/hail-services.md) - [All operations](https://skmtc.dev/hail-is/apis/hail-services/llms.txt) - [OpenAPI document](https://skmtc.dev/hail-is/apis/hail-services/revisions/cc95ba1cb4af?raw)