List Branches

List branches for a tenant with optional pagination and name filter

GET /v2/admin/branches

List Branches

cURL

curl --request GET \
  --url https://api.voxo.co/v2/admin/branches/ \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": 123,
    "tenantId": 123,
    "name": "<string>",
    "default": 123,
    "timezone": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

paginate · string · default: true

Enable pagination (true/false)

name · string

Filter branches by name

tenantId · number · required

Tenant ID to list branches for

page · number

Page number

recordsPerPage · number

Number of records per page

Response

200 - application/json

Branch list or paginated branch list

object[]

object

id · number · required

Branch ID

tenantId · number · required

Tenant ID

name · string · required

Branch name

default · number · required

Whether this is the default branch (1 = yes, 0 = no)

timezone · string | null · required

IANA timezone identifier