---
title: "List chunks"
method: GET
path: "/api/datasphere/documents/{documentId}/chunks"
tags: ["Chunks"]
---

# List chunks

`GET /api/datasphere/documents/{documentId}/chunks`

A list of chunks for a Datasphere Document.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _DataSphere_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

## Path parameters

- `documentId` string, uuid, required — Universal Unique Identifier.

## Query parameters

- `page_number` integer
- `page_size` integer
- `page_token` string

## Response `200`

The request has succeeded.

- DatasphereChunkListResponse
  - `data` DatasphereChunkResponse[], required — A list of chunks.
    - `id` string, uuid, required — Universal Unique Identifier.
    - `datasphere_document_id` string, uuid, required — Universal Unique Identifier.
    - `project_id` string, uuid, required — Universal Unique Identifier.
    - `status` 'submitted' | 'in_progress' | 'completed' | 'failed', required — The current Status of the Chunk.
    - `tags` string[], required — The tags of the document associated with the chunk.
    - `content` string, required — Content of the chunk.
    - `created_at` string, date-time, required — Chunk Creation Date.
    - `updated_at` string, date-time, required — Chunk Update Date.
  - `links` DatasphereChunkPaginationResponse, required
    - `self` string, uri, required — Link of the current page.
    - `first` string, uri, required — Link to the first page.
    - `next` string, uri — Link to the next page. Only present when there are more results.
    - `prev` string, uri — Link to the previous page. Only present when not on the first page.

## Other responses

- `400` — The request is invalid.
- `401` — Access is unauthorized.
- `404` — The server cannot find the requested resource.
- `422` — The request contains invalid parameters. See errors for details.
- `500` — An internal server error occurred.

---

[API](https://skmtc.net/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.net/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/signalwire/signalwire-rest-api/versions/05c5164b85c7/schema)