Skip to content

Get benefit code info

GET
/benefits/{benefitId}/codes/info
curl --request GET \
--url https://api.ethos.network/api/v2/benefits/1/codes/info

Get information about exclusive access codes for a benefit. Returns code availability and the current user’s claimed code if logged in.

benefitId
required
integer
> 0 <= 9007199254740991

Successful response

Media typeapplication/json
object
hasAccessCodes
required
boolean
totalCodes
required
number
claimedCodes
required
number
availableCodes
required
number
userClaimedCode
required
string | null

Example generated

{
"hasAccessCodes": true,
"totalCodes": 1,
"claimedCodes": 1,
"availableCodes": 1,
"userClaimedCode": "example"
}

Invalid input data

Media typeapplication/json
Invalid input data error (400)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}

Not found

Media typeapplication/json
Not found error (404)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}

Internal server error

Media typeapplication/json
Internal server error error (500)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}