Get a branch

GET

/v1/branches/{id}

const url = 'https://api.aerandil.com/v1/branches/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/branches/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

One branch by id, under the caller’s tenant. Requires objects:read.

Authorizations

aerandil_oauth

Parameters

Path Parameters

required

string format: uuid

Responses

200

The branch.

application/json

object

created_at

required

string format: date-time

forked_at_seq

required

The caller-tenant’s event-stream head seq at fork (fork-from-head only).

integer

required

string format: uuid

last_write_at

string format: date-time

merge_correlation_id

Present on a merged branch: the correlation id stamped on the branch.merged event and shared by every replayed main-log write, tying the merge record to the replayed events.

string format: uuid

merged_at

string format: date-time

name

required

string

status

required

string

Allowed values: open merged

Example

{
  "status": "open"
}

404

No such branch under this tenant.