Skip to navigation
API ReferenceCompany

List Branches

Returns your company’s branches (work locations), with each branch’s address and the location and radius used for location-based attendance. Deleted branches are not returned. Ordered by id.

Use the id values for the branches filter of List Staff and List Inactive Staff. Branch names are not guaranteed to be unique, so prefer IDs where you can.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 500.

Response

messagestring
statusboolean
datalist of objects
countinteger
Total number of branches.
prevstring or null

URL of the previous page, or null on the first page.

nextstring or null

URL of the next page, or null on the last page.