Skip to content

Get all employee budgets

Request

Query the available budget for all employees. This resource supports pagination

Security
ApiTokenAuth
Path
currencystringrequired

Currency

Enum:"CAD""USD"
Example:CAD
Headers
X-Workspace-idstringrequired

Workspace ID for authentication

Example:444
curl -i -X GET \
  https://docs.guusto.com/_mock/version/openapi/api/v1/balances/members/currencies/CAD \
  -H 'Authorization: Bearer <YOUR_ApiToken_HERE>' \
  -H 'X-Workspace-id: 444'

Responses

Successful available employee budget query

Bodyapplication/json
pageinteger, (int32)

Selected page for viewing

Example:1
sizeinteger, (int32)

Size of results per page

Example:50
totalElementsinteger, (int64)

Total amount of elements within query

Example:1
totalPagesinteger, (int32)

Total amount of pages within query

Example:1
memberBalanceResponsesArray of objects(MemberBalanceResponse)

Response object representing employees and their available budget for a given currency

Response
{
  "memberBalanceResponses": [
    {
      "amount": 10,
      "employeeNumber": "E393",
      "user": 4131
    },
    {
      "amount": 585,
      "employeeNumber": "E84901",
      "user": 5331
    }
  ]
}