---
title: "list"
method: GET
path: "/v1/project"
tags: ["Projects"]
---

# list

`GET /v1/project`

list all projects within your GroundX account.

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

## Query parameters

- `n` integer
- `nextToken` string

## Response `200`

Successful retrieval of projects

- ProjectListResponse
  - `projects` ProjectDetail[]
    - `buckets` BucketDetail[] — The content buckets associated with the project
      - `bucketId` integer, required
      - `created` string, date-time — The data time when the bucket was created, in RFC3339 format
      - `fileCount` integer — The number of files contained in the content bucket
      - `fileSize` string — The total file size of files contained in the content bucket
      - `name` string
      - `updated` string, date-time — The data time when the bucket was last updated, in RFC3339 format
    - `created` string, date-time — The data time when the project was created, in RFC3339 format
    - `fileCount` integer — The number of files contained in the content buckets associated with the project
    - `fileSize` string — The total file size of files contained in the content buckets associated with the project
    - `projectId` integer, required
    - `name` string
    - `updated` string, date-time — The data time when the project was last updated, in RFC3339 format

## Changes

- **2023-11-29** `3bb565058636` — 2 info
  - added the new optional `query` request parameter `n`
  - added the new optional `query` request parameter `nextToken`
- **2023-11-29** `bf7061385e18` — 1 warning
  - removed the optional property `projects/items/groupId` from the response with the `200` status
- **2023-10-13** `43657b55255e` — 3 info
  - added the optional property `projects/items/buckets/items/created` to the response with the `200` status
  - added the optional property `projects/items/buckets/items/updated` to the response with the `200` status
  - added the optional property `projects/items/groupId` to the response with the `200` status
- **2023-10-05** `5ee59ea914aa` — 2 info
  - api tag `Projects` added
  - api tag `Project` removed
- **2023-10-05** `05194fdd107e` — 1 breaking, 1 info
  - the `projects/items/projectId` response's property type changed from `string` to `integer` for status `200`
  - the response property `projects/items/projectId` became required for the status `200`

[Full history](https://skmtc.dev/groundxai/apis/groundx-apis/changes/v1/project/get.md)

---

[API](https://skmtc.dev/groundxai/apis/groundx-apis.md) · [All operations](https://skmtc.dev/groundxai/apis/groundx-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/groundxai/apis/groundx-apis/revisions/d177cd9fa116?raw)