Guusto Gifts API (1.0)

Resources that enables seamless integration with Guusto’s recognition platform, allowing you to send gifts, track gift statuses, manage recipient details and many more with ease.

Servers

Mock server

https://docs.guusto.com/_mock/version/openapi/

Demo Test Environment

https://api-demo.guusto.io/

Production Environment

https://api.guusto.com/

Account Budget

Operation for querying Workspace account budget

Operations

Get budget

Request

Query available Workspace account budget by currency.

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/workspaces/currencies/CAD \
  -H 'Authorization: Bearer <YOUR_ApiToken_HERE>' \
  -H 'X-Workspace-id: 444'

Responses

Available budget

Bodyapplication/json

balancenumber

Available budget

Example: 20000

Response

application/json

{
  "balance": 10000
}

Get an employee budget

Request

Query an employee available budget

Path

employeeNumberstringrequired

Employee Number

Example: 29392

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/29392/currencies/CAD \
  -H 'Authorization: Bearer <YOUR_ApiToken_HERE>' \
  -H 'X-Workspace-id: 444'

Responses

Successful available employee budget query

Bodyapplication/json

amountnumber

Available amount

Example: 10000

currencystring

Currency

Enum"CAD""USD"

Example: "CAD"

Response

application/json

{
  "amount": 100,
  "currency": "CAD"
}

Get all employee budgets

Request

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

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

application/json

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

Order Gift

Operations for creating and managing gift orders

Operations

Reports

Operations for reporting insights and analytics

Operations