List shelves

Lists all shelves (saved workspace states) for the current user in a repository, optionally filtered by branch_id parameter.

Each shelf includes:

• ID
• Name
• Creation timestamp
• Associated branch and commit IDs

About shelves: Shelves allow users to temporarily save uncommitted changes for later reapplication.

Requirements: Requires READ access to the repository.

GET /repos/{repo_id}/shelves

Get a list of all shelves in the repo.

cURL

curl --request GET \
  --url https://api.diversion.dev/v0/repos/{repo_id}/shelves \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_timestamp": 123,
      "branch_id": "<string>"
    }
  ]
}

Authorizations

OAuth2OAuth2

Authorization · string · header · required

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id · string · required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

Query Parameters

branch_id · string

Optional branch id to filter by

Response

200

application/json

A list of shelf objects

object · enum<string> · required

Available options: Shelf

items · object[] · required

Show child attributes