Get bounty

Retrieve a single bounty by id. With a private key, the response also includes a progress block: a page of every progress record on that bounty. The bounty itself is looked up by bountyId alone and is never paged, so exactly one bounty is always returned. With a public key, or with a private key and includeProgress set to the literal string false, the response has no progress block. Any other value of includeProgress, including 0, still returns progress. If bountyId doesn’t match a bounty visible to this creator group, this returns 404 with BountyNotFound. This does not check endsAt, so an ended bounty can still be retrieved.

Authorizations

X-SHARED-SECRET

required

stringheader

Can be either private or public key. Response will vary based upon the key used.

Parameters

Path Parameters

bountyId

required

string

Example

2ixlNNFdJh-9scoXek80w

ID of bounty to retrieve

Query Parameters

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.

includeProgress

boolean

default: true

Example

false

If set to the literal string false, progress is left out of the response. Any other value, including 0, still includes it. Ignored entirely when using public key auth, since progress is never returned to a public key.

page

integer format: int32

default: 1 >= 1 <= 9999

Page of the progress list to return.

pageSize

integer format: int32

default: 100 >= 1 <= 100

Page size for the progress list.

Responses

200

Details of specified bounty

application/json

object

groupId

ID of the creator group

string

groupName

Name of the creator group

string

bounty

object

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

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

string

name

string

slug

string

category

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

object

string

name

string

slug

string

publisher

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

object

string

name

string

rewards

Array<object>

A reward to be granted upon completion of a bounty

object

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

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

string

name

string

prerequisites

Array<object>

object

string

name

string

progress

object

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

data

Array

object

string

completed

Whether the creator has completed this bounty. Bounties will not be considered completed until the completion limit has been reached

boolean

completionCount

number

lastProgressCheck

string format: date-time

currentObjectiveGroupId

string

currentObjectives

Array<object>

object

string

completed

boolean

count

number

objective

object

string

name

string

count

number

condition

string

Allowed values: AND OR

completedObjectives

Array<object>

object

objectiveGroupId

string

objectives

Array<object>

object

string

completed

boolean

count

number

objective

object

string

name

string

count

number

condition

string

Allowed values: AND OR

rewards

Array<object>

object

The bounty progress reward’s id.

string

name

The bounty reward’s name.

string

externalId

Your own catalog id for this reward.

string

rewardCompleted

Whether this reward has been completed. Becomes true the first time this endpoint successfully completes it, and does not change on later calls.

boolean

rewardReferenceId

The referenceId from the first completion call. Not changed by a later call to this endpoint.

string

member

object

string

playerId

Unique identifier for this member’s in-game user, set when linking with their Nexus account or generating the code

string

name

string

codes

Array<object>

A group member’s code which is used as their storefront URL and when creating transactions or referrals

object

code

string

isPrimary

Indicates whether or not this is the primary code for this member.

boolean

isGenerated

Indicates whether or not this is a code that you generated.

boolean

isManaged

Indicates whether or not this is a code that you manage. Once a code that you generated has been linked to a Nexus account, it will no longer be considered managed.

boolean

creator

object

string

playerId

Unique identifier for this creator’s in-game user, set when linking with their Nexus account or generating the Referral code

string

name

string

slugs

Array<string>

400

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

application/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

/{bountyId}

const url = 'https://api.nexus.gg/v1/bounties/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO&includeProgress=true&page=1&pageSize=100';
const options = {method: 'GET', headers: {'X-SHARED-SECRET': 'nexus_pk_your_key_here'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.nexus.gg/v1/bounties/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO&includeProgress=true&page=1&pageSize=100' \
  --header 'X-SHARED-SECRET: nexus_pk_your_key_here'

Example

{
  "groupId": "V1StGXR8_Z5jdHi6B1LiO",
  "groupName": "Aurora Drift Creators",
  "bounty": {
    "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"
      }
    ]
  },
  "progress": {
    "currentPage": 1,
    "currentPageSize": 100,
    "totalCount": 1,
    "data": [
      {
        "id": "ePIWtwm6XnH1lqSpXeKo_",
        "completed": false,
        "completionCount": 3,
        "currentObjectiveGroupId": "Hd6zrUid8ulc0boV5Z5ws",
        "currentObjectives": [
          {
            "id": "T4h8O0p2aOakYG0WhBTEN",
            "completed": false,
            "count": 1,
            "objective": {
              "id": "U3NIDcqNIgiG9S9mfmN4H",
              "name": "Refer a player that reaches level 20",
              "count": 5,
              "condition": "AND"
            }
          }
        ],
        "completedObjectives": [
          {
            "objectiveGroupId": "R2vbVWNC4SHhC2lk_QHsq",
            "objectives": [
              {
                "id": "T4h8O0p2aOakYG0WhBTEN",
                "completed": false,
                "count": 1,
                "objective": {
                  "id": "U3NIDcqNIgiG9S9mfmN4H",
                  "name": "Refer a player that reaches level 20",
                  "count": 5,
                  "condition": "AND"
                }
              }
            ],
            "rewards": [
              {
                "id": "2ixlNNFdJh-9scoXek80w",
                "name": "In-Game Title",
                "externalId": "reward_mvp_title",
                "rewardCompleted": true,
                "rewardReferenceId": "ticket-48213"
              }
            ]
          }
        ],
        "member": {
          "id": "9jd7RBR_B2BZ0uWO3_lgv",
          "playerId": "player_8f2c41d0",
          "name": "PopcornFrog",
          "codes": [
            {
              "code": "samzorz",
              "isPrimary": true,
              "isGenerated": false,
              "isManaged": false
            }
          ]
        },
        "creator": {
          "id": "9jd7RBR_B2BZ0uWO3_lgv",
          "playerId": "player_8f2c41d0",
          "name": "PopcornFrog",
          "slugs": [
            "[\"popcornfrog\",\"dlfkjab-do\"]"
          ]
        }
      }
    ]
  }
}

Example

{
  "code": "InvalidGroup",
  "message": "Bounty Not found"
}