---
title: "read bundle"
method: POST
path: "/v1/tenants/{tenant_id}/bundle/read"
tags: ["Bundle"]
---

# read bundle

`POST /v1/tenants/{tenant_id}/bundle/read`

## Path parameters

- `tenant_id` string, required

## Request body

- BundleReadBody
  - `name` string

## Response `200`

A successful response.

- BundleReadResponse
  - `bundle` DataBundle — DataBundle is a message representing a bundle of data, which includes a name, a list of arguments, and a series of operations.
    - `name` string — 'name' is a simple string field representing the name of the DataBundle.
    - `arguments` string[] — 'arguments' is a repeated field, which means it can contain multiple strings. These are used to store a list of arguments related to the DataBundle.
    - `operations` V1Operation[] — 'operations' is a repeated field containing multiple Operation messages. Each Operation represents a specific action or set of actions to be performed.
      - `relationships_write` string[] — 'relationships_write' is a repeated string field for storing relationship keys that are to be written or created.
      - `relationships_delete` string[] — 'relationships_delete' is a repeated string field for storing relationship keys that are to be deleted or removed.
      - `attributes_write` string[] — 'attributes_write' is a repeated string field for storing attribute keys that are to be written or created.
      - `attributes_delete` string[] — 'attributes_delete' is a repeated string field for storing attribute keys that are to be deleted or removed.

## Other responses

- `default` — An unexpected error response.

## Changes

- **2025-12-28** `f37e45046dd2` — 1 breaking
  - the `details/items/additionalProperties/` response's property type/format changed from `object`/`` to ``/`` for status `default`
- **2024-08-23** `f3b10e35081b` — 1 breaking, 2 info
  - added required request body
  - added the media type `application/json` for the response with the status `200`
  - added the media type `application/json` for the response with the status `default`
- **2024-08-22** `282fb7ba2640` — 3 breaking
  - removed the request body
  - removed the media type `application/json` for the response with the status `200`
  - removed the media type `application/json` for the response with the status `default`
- **2024-03-19** `0bc305aa169f` — 1 breaking
  - the `details/items/additionalProperties/` response's property type/format changed from ``/`` to `object`/`` for status `default`

[Change history](https://skmtc.dev/permify/apis/permify-api/changes/v1/tenants/:tenant_id/bundle/read/post.md)

---

[API](https://skmtc.dev/permify/apis/permify-api.md) · [All operations](https://skmtc.dev/permify/apis/permify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/permify/permify-api/revisions/73b7d5b3742e/schema)