Skip to main content
GET
List the institution's branches

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Response

Successful Response

Paginated list of the institution's branches.

items
BranchSummary · object[]
required

Page of the branches you can reference, in the institution's stored order. Hidden branches are included; a legacy branch without a name is not.

total
integer
required

Number of branches you can reference. A legacy branch without a name is not counted.

page
integer
required

Current page (1-based).

limit
integer
required

Items per page.