## Paginated List Pipeline Documents

`DocumentListPageResponse Pipelines.Documents.List(DocumentListParamsparameters, CancellationTokencancellationToken = default)`

**get** `/api/v1/pipelines/{pipeline_id}/documents/paginated`

Return a list of documents for a pipeline.

### Parameters

- `DocumentListParams parameters`

  - `required string pipelineID`

  - `string? fileID`

  - `Long limit`

  - `Boolean? onlyApiDataSourceDocuments`

  - `Boolean? onlyDirectUpload`

  - `Long skip`

  - `StatusRefreshPolicy statusRefreshPolicy`

    - `"cached"Cached`

    - `"ttl"Ttl`

### Returns

- `class DocumentListPageResponse:`

  - `required IReadOnlyList<CloudDocument> Documents`

    The documents to list

    - `required string ID`

    - `required IReadOnlyDictionary<string, JsonElement> Metadata`

    - `required string Text`

    - `IReadOnlyList<string> ExcludedEmbedMetadataKeys`

    - `IReadOnlyList<string> ExcludedLlmMetadataKeys`

    - `IReadOnlyList<Long>? PagePositions`

      indices in the CloudDocument.text where a new page begins. e.g. Second page starts at index specified by page_positions[1].

    - `IReadOnlyDictionary<string, JsonElement>? StatusMetadata`

  - `required Long Limit`

    The limit of the documents

  - `required Long Offset`

    The offset of the documents

  - `required Long TotalCount`

    The total number of documents

### Example

```csharp
DocumentListParams parameters = new()
{
    PipelineID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var page = await client.Pipelines.Documents.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

#### Response

```json
{
  "documents": [
    {
      "id": "id",
      "metadata": {
        "foo": "bar"
      },
      "text": "text",
      "excluded_embed_metadata_keys": [
        "string"
      ],
      "excluded_llm_metadata_keys": [
        "string"
      ],
      "page_positions": [
        0
      ],
      "status_metadata": {
        "foo": "bar"
      }
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}
```