The Branch API

To use the Branch API endpoints, your key must be assigned the Branches Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

The Branch API contains methods for retrieving library branch and location information. For more information, see Branch Addresses Table in the Sierra WebHelp.

With the Branch API, you can:

The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.

Get a List of Branches

GET /v6/branches/

Returns the properties of the first x branch objects (where x = the default record limit) from the Branch Addresses Table.

Try it out!

Get a List of Pickup Locations

GET /v6/branches/pickupLocations

Returns a Location object containing a list of high-level location codes and associated code names. This endpoint returns the label and first branch location for each pickup location entry only; it does not include additional locations, paging priority, or agency values.

Try it out!

Get a Branch by Branch ID

GET /v6/branches/{id}

Returns a single branch object from the Branch Addresses Table. The specified branch ID is the line number from the Branch Addresses Table for that branch.

Try it out!