List

API Reference

Vals

Branches

List

client.vals.branches.list(stringvalId, BranchListParamsquery, RequestOptionsoptions?): PageCursorURL<idstringcreatedAtstringforkedBranchIdunionlinksLinksnamestringupdatedAtstringversionnumberBranchListResponse>

get/v2/vals/{val_id}/branches

List all branches for a val

Parameters

valIdstring

formatuuid

querylimitnumberoffsetnumberBranchListParams

Hide ParametersShow Parameters

limitnumber

Maximum items to return in each paginated response

minimum1

maximum100

offsetnumber

Number of items to skip in order to deliver paginated results

minimum0

Returns

BranchListResponse

A Branch

Hide ParametersShow Parameters

idstring

The id of the branch

formatuuid

createdAtstring

formatdate-time

forkedBranchIdunion

string | null

The id of the branch this branch was forked from

linkshtmlstringselfstringLinks

Hide ParametersShow Parameters

htmlstring

The URL of this resource on Val Town

formaturi

selfstring

The URL of this resource on this API

formaturi

namestring

updatedAtstring

formatdate-time

versionnumber

minimum0

HTTPTypeScript

import ValTown from '@valtown/sdk';

const client = new ValTown();

// Automatically fetches more pages as needed.
for await (const branchListResponse of client.vals.branches.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  limit: 1,
  offset: 0,
})) {
  console.log(branchListResponse.id);
}

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "forkedBranchId": "forkedBranchId",
      "links": {
        "html": "https://example.com",
        "self": "https://example.com"
      },
      "name": "name",
      "updatedAt": "2019-12-27T18:11:19.117Z",
      "version": 0
    }
  ],
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}