List available branches

GET /docs/{doc_id_or_slug}/branches

List the available branches of a given documentation.

Path parameters

  • doc_id string Required

    UUID or slug of a documentation which can be seen in the CI deployment settings page of your documentation


  • 200 application/json

    Array of existing branches

    Hide response attributes Show response attributes object
    • name string

      Unique id of the branch.

    • slug string

      Slug of the branch used in public documentation URL

    • is_default boolean

      Whether the branch is the default one or not.

      Default value is false.

  • Documentation does not exist

GET /docs/{doc_id_or_slug}/branches
curl \
 -X GET{doc_id_or_slug}/branches \
 -H "Authorization: Token $ACCESS_TOKEN"
Response examples (200)
    "name": "3ef8f52f-9056-4113-840e-2f7183b90e06",
    "slug": "my-branch",
    "is_default": false