Retrieve Multiple Branches

Returns an array of branch objects

https://mapi.storyblok.com/v1/spaces/:space_id/branches/

Path Parameters

:space_id
required number

Numeric ID of a space

Query Parameters

by_ids
string

Filter by branch IDs (comma separated)
search
string

Filter by search term

Response Properties

branches
The Branch Object[]

Array of branch objects
- id
  number
  
  Branch ID
- name
  string
  
  Branch Name
- space_id
  number
  
  Numeric ID of a space
- deleted_at
  string
  
  Deleted date (Format: YYYY-mm-dd HH:MM)
- created_at
  string
  
  Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- updated_at
  string
  
  Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- source_id
  number or null
  
  Source of this branch null or id of another branch
- deployed_at
  string
  
  Deployed date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- url
  string
  
  Preview URL for this branch
- position
  number
  
  Numeric representation of the branch position

Select a Language

Request

curl "https://mapi.storyblok.com/v1/spaces/606/branches/" \
  -X GET \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json"

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.get('/spaces/606/branches/', {})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$client->get('/spaces/606/branches/')->getBody();

Request

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

client.false('/spaces/606/branches/')

Request

HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/spaces/606/branches/")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .asString();

Request

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/branches/");
var request = new RestRequest(Method.GET);

request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
IRestResponse response = client.Execute(request);

Request

import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/branches/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Request

import requests

url = "https://mapi.storyblok.com/v1/spaces/606/branches/"

querystring = {}

payload = ""
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)

You will receive an array of branch objects.

Prev Retrieve a Single Branch

Next Create a Branch