GuidesAPI Reference
Log In
API Reference
  1. Bonusly
  2. Bonuses

List Bonuses

get
https://bonus.ly/api/v1/bonuses

Returns a paginated list of bonuses for the authenticated user's company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20

Number of bonuses to retrieve (min: 1, max: 100).

integer
≥ 0
Defaults to 0

Number of bonuses to skip, for pagination (min: 0).

date-time

ISO8601 lower bound on bonus created_at (inclusive). Example: 2026-05-01T00:00:00Z.

date-time

ISO8601 upper bound on bonus created_at (inclusive). Example: 2026-05-31T23:59:59Z.

integer

Shorthand for start_time — restricts to bonuses created in the last N hours.

string

Filter to bonuses given by the user with this email.

string

Filter to bonuses received by the user with this email.

string

Filter to bonuses where this user is either giver or receiver. Cannot be combined with giver_email/receiver_email.

string

Filter to bonuses tagged with this hashtag. Example: #teamwork (URL-encoded as %23teamwork).

boolean

When true, filter to bonuses involving the authenticated user or their most-relevant colleagues.

boolean

When true, exclude zero-amount bonuses (e.g. add-ons).

boolean

When true, exclude archived bonuses.

boolean
Defaults to false

When true, include the full child_bonuses array on each parent (instead of just child_count).

boolean

When true, include private bonuses the authenticated user can see (admin-only).

Responses

Updated 2 months ago

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

Updated 2 months ago