GUgupy
Company Branches

Listing branches

Returns a list of company branches.

get/branches

Request

  • Base URL
    https://api.gupy.io/api/v1
  • URL
    https://api.gupy.io/api/v1/branches
  • Auth
    HTTP bearer

Query parameters

fieldsstring

Specify fields to return (eg. fields=id,name or fields=all).
Default: id, code, name, createdAt, updatedAt

idinteger

Branch id to filter

namestring

Branch name to filter

codestring

Branch code to filter

perPageinteger

Pagination: How many items per page

pageinteger

Pagination: Which page to query

Response

An array of branches

totalResultsinteger
pageinteger
totalPagesinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.