Skip to main content
GET
/
repos
/
{repo_id}
/
shelves
/
{shelf_id}
Get shelf details
curl --request GET \
  --url https://api.diversion.dev/v0/repos/{repo_id}/shelves/{shelf_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "created_timestamp": 123,
  "branch_id": "<string>"
}

Authorizations

​
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"

​
shelf_id
string
required

Shelf identifier

Required string length: 3 - 128
Example:

"dv.shelf.12a37e91-bfc4-4e03-a330-13b5b84ab7cb"

Response

Shelf details returned

​
id
string
required

Shelf identifier in Diversion

​
name
string
required

Display name of the shelf

​
created_timestamp
integer<int64>
required

Seconds since epoch UTC

​
branch_id
string

Optional branch ID from which the changes were shelved