API Reference

Listing branches

get
https://api.gupy.io/api/v1/branches

Returns a list of company branches.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The branches represents the organization structure in a tree model.

Query Params
string

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

int64

Branch id to filter

string
length ≤ 255

Branch name to filter

string
length ≤ 200

Branch code to filter

int64
Defaults to 10

Pagination: How many items per page

int64
Defaults to 1

Pagination: Which page to query

Responses

Updated about 1 year ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago