---
title: "Get contract image groups with images"
method: GET
path: "/contracts/{contract_id}/image_groups"
tags: ["Contract - Images"]
---

# Get contract image groups with images

`GET /contracts/{contract_id}/image_groups`

## Request

- Base URL: `https://api.oneflow.com/v1`
- URL: `https://api.oneflow.com/v1/contracts/{contract_id}/image_groups`
- Auth: none declared. Required headers: `x-oneflow-api-token`

Use this endpoint to retrieve all image groups and the image associated with each group for the specified contract ID.

## Path parameters

- `contract_id` integer, required

## Query parameters

- `offset` integer
- `limit` string, limit

## Headers

- `x-oneflow-api-token` string, required

## Response `200`

Returns the requested contract image groups list.

- object: A collection of image groups and their images associated with a contract.
  - `_links` object: Links to related endpoints.
    - `comments` object
      - `href` string, nullable
    - `contracts` object
      - `href` string, nullable
    - `contract` object
      - `href` string, nullable
    - `create` object
      - `href` string, nullable
    - `data_field` object
      - `href` string, nullable
    - `data_fields` object
      - `href` string, nullable
    - `events` object
      - `href` string, nullable
    - `event` object
      - `href` string, nullable
    - `files` object
      - `href` string, nullable
    - `file` object
      - `href` string, nullable
    - `next` object
      - `href` string, nullable
    - `parties` object
      - `href` string, nullable
    - `party` object
      - `href` string, nullable
    - `previous` object
      - `href` string, nullable
    - `publish` object
      - `href` string, nullable
    - `self` object
      - `href` string, nullable
    - `template_types` object
      - `href` string, nullable
    - `template_type` object
      - `href` string, nullable
    - `template` object
      - `href` string, nullable
    - `templates` object
      - `href` string, nullable
    - `workspaces` object
      - `href` string, nullable
    - `workspace` object
      - `href` string, nullable
    - `playbooks` object
      - `href` string, nullable
  - `count` integer, required
  - `data` object[], required
    - `_private_ownerside` object, nullable, required: Image group data that is private to the ownerside.
      - `created_time` string, datetime, required
      - `custom_id` string, nullable, required
      - `updated_time` string, datetime, nullable, required
    - `files` object[], required: A list of image files in the group.
      - `_private_ownerside` object, nullable, required: File data that is private to the ownerside.
        - `created_time` string, datetime, required
        - `updated_time` string, datetime, nullable, required
      - `alt_text` string, nullable, required: The alternative text of the image.
      - `extension` string, nullable, required: The image extension.
      - `id` integer, required
      - `size` integer, nullable, required: The size of the image in bytes.
    - `id` integer, required
    - `type` 'image', required: The type of the image group. The only available type is `image`.

## Other responses

- `400`: Invalid format or content of the request.
- `401`: The API token or the user email is invalid.
- `404`: A required entity is missing.

## Changes

- **2026-11-03** `0a4e1e88ac45`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/oneflow/apis/public-api-for-oneflow/changes/contracts/:contract_id/image_groups/get.md)

---

[API](https://skmtc.dev/oneflow/apis/public-api-for-oneflow.md) - [All operations](https://skmtc.dev/oneflow/apis/public-api-for-oneflow/llms.txt) - [OpenAPI document](https://skmtc.dev/oneflow/apis/public-api-for-oneflow/revisions/0a4e1e88ac45?raw)