Skip to content

Lists the bounties available to a creator group. Only bounties that are enabled, not deleted, and already started are returned; a bounty scheduled with a future startsAt is left out until it starts. Bounties that have ended stay in the list, so filter on endsAt if you only want the ones currently running. Paging starts at page 1. Use totalCount to work out how many pages there are.

X-SHARED-SECRET
required
stringheader
groupId
string
Example
V1StGXR8_Z5jdHi6B1LiO

Creator group to use for this operation. If your key is scoped to a single program, that group is always used regardless of this value; otherwise falls back to your default group when omitted.

page
integer format: int32
default: 1 >= 1 <= 9999

Page of records to return

pageSize
integer format: int32
default: 100 >= 1 <= 100

Number of records per page.

List of bounties

Media typeapplication/json
object
groupId

ID of the creator group

string
groupName

Name of the creator group

string
currentPage

Page number of response records returned

integer format: int32
currentPageSize

Page size used for this operation

integer format: int32
totalCount

Total number of referrals

integer format: int32
bounties
Array<object>
object
id
string
name
string
description
string
imageSrc
string
rewardDescription

Text describing the reward for this bounty

string
limit

How many time a creator can complete this bounty

number
startsAt
string format: date-time
endsAt
string format: date-time
lastProgressCheck
string format: date-time
objectives
Array<object>

A requirement for completing a bounty

object
id
string
name
string
type
string
Allowed values: Event Referral NexusPurchase
condition

All objectives with “AND” are required for bounty completion. Only one objective with “OR” is required. If objective 1, 2, and 3 are all “AND” condition and objective 4 and 5 are “OR” condition, the bounty will be considered complete when 1, 2, 3, and either 4 or 5 are completed.

string
Allowed values: AND OR
count
number
eventType

Only applies to objectives with type “Event”. This field specifies whether an event counted toward this objective should originate from the creator’s in game user or from a user that is a referral of the creator.

string
Allowed values: Referral Creator
eventCode

Event code that is counted toward this bounty.

string
nexusPurchaseObjectiveType

Only applies to objectives with type “NexusPurchase”. This field specifies is used to determine which purchases will count toward the objective. “Category” means that any sku purchased with a specific will count (all microtransactions for a specific game would have the same category, for example). “Publisher” means that any skus belonging to a specific publisher will count. “Sku” means that a specific list of skus will apply to this objective.

string
Allowed values: Category Publisher Sku
skus

Only applies to objectives with the type “NexusPurchase” and nexusPurchaseObjectiveType “Sku”

Array<object>

Sku

object
id
string
name
string
slug
string
category

Only applies to objectives with the type “NexusPurchase” and nexusPurchaseObjectiveType “Category”

object
id
string
name
string
slug
string
publisher

Only applies to objectives with the type “NexusPurchase” and nexusPurchaseObjectiveType “Publisher”

object
id
string
name
string
rewards
Array<object>

A reward to be granted upon completion of a bounty

object
id
string
name
string
type

A reward of type “Sku” will provide the creator with a key that can be redeemed in steam, in game, etc. “Payment” will result in the creator being paid a specified amount of currency. “External” means the reward should be not be provided by nexus. When a bounty is completed with an “External” reward, a message is sent to the bounty webhook. This API also may be used to mark a “External” reward as completed and associate it with a reference ID.

string
Allowed values: Sku Payment External
sku

Sku

object
id
string
name
string
slug
string
amount

Amount of currency to be applied to a “Payment” type or the quantity of a “Sku”

number
currency
string
Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTC BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VEF VND VUV WST XAF XAG XAU XCD XDR XOF XPF YER ZAR ZMK ZMW ZWL
externalId

Unique identifier intended to map this reward to something in the external reward provider’s system

string
dependants
Array<object>
object
id
string
name
string
prerequisites
Array<object>
object
id
string
name
string

Returned when groupId does not match a creator group on your publisher account.

Media typeapplication/json
object
code

CodeNotInGroup: Creator group is private, and specified code is not linked to it
InvalidGroup: No creator group was found with the specified groupId
InvalidAuthCode: AuthCode provided is not valid
ExpiredAuthCode: AuchCode provided has expired
ReferralNexusNotFound: No Nexus was found to match the provided referral code
BountyNotFound: No bounty was found with the specified bountyId
CreatorNotFound: No creator found with the specified creatorId
InvalidEventCode: No event found with the specifed event code

string
Allowed values: InvalidGroup CodeNotInGroup InvalidAuthCode ExpiredAuthCode ReferralNexusNotFound BountyNotFound MemberNotFound InvalidEventCode UnknownError
message
string
GET
/
curl --request GET \
--url 'https://api.nexus.gg/v1/bounties/?groupId=V1StGXR8_Z5jdHi6B1LiO&page=1&pageSize=100' \
--header 'X-SHARED-SECRET: nexus_pk_your_key_here'
Example
{
"groupId": "V1StGXR8_Z5jdHi6B1LiO",
"groupName": "Aurora Drift Creators",
"currentPage": 1,
"currentPageSize": 100,
"totalCount": 1,
"bounties": [
{
"id": "XrEeF3CrtiSuz2xu8Y6O1",
"name": "Refer 5 players that reach level 20",
"description": "Refer 5 players that reach level 20 in Great Game and receive 200 IGC",
"imageSrc": "https://cdn.nexus.gg/CsRKC8uD0NLtyQ0LOt8Ru/images/profile-image.jpg",
"rewardDescription": "200 IGC",
"limit": 5,
"startsAt": "2026-01-02T16:24:22.931Z",
"endsAt": "2026-01-02T16:24:22.931Z",
"lastProgressCheck": "2026-01-02T16:24:22.931Z",
"objectives": [
{
"id": "CsRKC8uD0NLtyQ0LOt8Ru",
"name": "Refer a player that reaches level 20",
"type": "Event",
"condition": "AND",
"count": 5,
"eventType": "Referral",
"eventCode": "reachLevel20",
"nexusPurchaseObjectiveType": "Category",
"skus": [
{
"id": "b5ajhvFLV4icmACR9KeG1",
"name": "Great Game 200 IGC",
"slug": "great-game-200-igc"
}
],
"category": {
"id": "DYxdHsSLsVziD1dJ_TR0w",
"name": "Great Game",
"slug": "great-game"
},
"publisher": {
"id": "sRee30J5v6cXNYqsyTfbb",
"name": "Great Game Publishing"
}
}
],
"rewards": [
{
"id": "2Qw7VPSYk1Me7o6huoXwl",
"name": "200 In-Game currency",
"type": "Sku",
"sku": {
"id": "b5ajhvFLV4icmACR9KeG1",
"name": "Great Game 200 IGC",
"slug": "great-game-200-igc"
},
"amount": 5,
"currency": "AED"
}
],
"dependants": [
{
"id": "TAMiHCZtHaAle78ArHJva",
"name": "Refer 5 Players"
}
],
"prerequisites": [
{
"id": "Ev-vRz88frq0RSxp51VP3",
"name": "Refer 5 Players"
}
]
}
]
}