Branches

Get a branch by ID

Returns the details of a specific branch.

get/branches/{branch_id}

Request

  • Base URL: https://api.streamtime.net/v2
  • URL: https://api.streamtime.net/v2/branches/{branch_id}
  • Auth: HTTP bearer

Path parameters

branch_idinteger required

Response

Branch fetched successfully.

idinteger

Branch ID

namestring

Branch name

externalNamestring nullable

External display name

taxNumberstring nullable

Branch tax number

addressstring nullable

Formatted branch address

activeboolean

Is the branch active

Example response

{
  "name": "Head Office",
  "externalName": "Acme HQ",
  "taxNumber": "NZ123-456-789",
  "address": "123 High St, Auckland 1010, New Zealand",
  "active": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.