GET
/
api
/
loyalty
/
badges

Query Parameters

organizationId
string

UUID of the organization (optional, converted to lowercase)

websiteId
string

UUID of the website (optional, converted to lowercase)

badgeIds
string[]

Array of badge IDs (converted to lowercase) to fetch

userId
string

UUID of the user (optional, converted to lowercase)

startingAfter
string

UUID of the badge to start after (converted to lowercase)

limit
integer | null

Number of badges to fetch

includeDeleted
boolean | null
default: false

Include deleted badges in the response

Response

200 - application/json

Response returned upon successful fetching of the badges.

badges
object[]
required