GuidesAPI Reference
Log In
API Reference
  1. Awards

List awards for the authenticated user's company.

get
https://bonus.ly/api/public/awards

Returns a paginated list of awards belonging to the user's company.
Supports filtering by state. Uses opaque cursor pagination — pass
page_size (and optionally state) on the first call; on subsequent
calls pass only the returned next_cursor. Results are ordered by ID
ascending.

Requires the awards:read scope and awards admin permission.

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

Filter awards by state.

Allowed:
string

Opaque pagination cursor returned as next_cursor from a previous response. When present, page_size and state are carried inside the cursor and query params for those fields are ignored.

integer
1 to 100
Defaults to 20

Number of results per page. Defaults to 20, maximum 100. Ignored when cursor is present (page size is encoded in the cursor).

Responses

Updated 2 months ago

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

Updated 2 months ago