Raffle System
  1. raffle
Raffle System
  • Raffles
    • authentication
      • admin login
      • user login
    • awarded-boxes
      • getAll
      • open awarded box
      • create
      • getAll by raffleId
      • delete
    • awarded-boxes-combo
      • create
      • getAll by raffleId
      • update
      • delete
    • tracking
      • get tracking info
    • pay2m-api
      • access token generation
      • generate billing qr code
      • consult qr code
      • list webhook
      • register/update webhook
      • delete webhook
    • provider-api
      • auth login
      • create pix static
      • get webhooks
      • create webhook
      • get balance
      • get extracts
      • edit webhook
      • delete webhook
      • get webhook details
      • restore webhook
    • winner
      • get quota prize winners
    • general
      • update settings
      • get settings
      • create notifications
      • get notifications
      • get notification by id
      • update notification
      • delete notification
      • create faq
      • get faqs
      • get faq by id
      • update faq
      • delete faq
    • metrics
      • get sales by day for raffle
      • get top buyers by raffle
      • get general metrics
      • get last orders
      • get raffle percentage of sales
      • get orders summary
      • get badges
      • get sell bar
      • get fake sold quotas percentage
      • create fake sold quotas percentage
      • update fake sold quotas percentage
    • payments
      • get payment providers
      • create/update payment provider
      • get payment provider by name
      • get pix payments
      • get my pix payments
      • get pix payment details
    • order
      • create order withou payment method
      • create order
      • get orders
      • get orders by raffle id
      • get my orders
      • get order details
      • pay order
      • cancel order
    • lucky-numbers
      • get lucky numbers by raffleId
      • get lucky numbers by orderId
    • raffle
      • toggle awarded boxes visualization
        PATCH
      • toggle awarded boxes winners visualization
        PATCH
      • toggle acumulative combo
        PATCH
      • update category
        PATCH
      • delete category
        DELETE
      • create raffle category
        POST
      • get categories
        GET
      • create raffle
        POST
      • get raffles
        GET
      • get raffle details
        GET
      • delete raffle
        DELETE
      • update raffle
        PATCH
      • get winners
        GET
      • get winner details
        GET
      • get winner info
        GET
      • create winner
        POST
      • upload file
        POST
    • user
      • create user
      • get users
      • update user
      • get user details
      • delete user
      • get user by phone
      • get profile
      • create customer
      • update customer
  1. raffle

get raffles

GET
/v1/raffles
raffle
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/raffles'
Response Response Example
{
    "raffles": [
        {
            "id": 1,
            "title": "Luxury Car Giveaway",
            "statusText": "Open for reservations",
            "slug": "luxury-car-giveaway",
            "status": "ACTIVE",
            "startsAt": "2025-02-14T18:54:03.613Z",
            "quotaQuantity": 100,
            "quotaPrice": "50",
            "endsAt": "2025-02-21T18:54:03.613Z",
            "freeCampaign": false,
            "photoUrl": "https://example.com/photo.jpg",
            "createdAt": "2025-02-14T18:54:03.615Z",
            "privacy": "PUBLIC",
            "showProgressBar": true,
            "showPrices": true,
            "isHighlighted": false,
            "subtitle": "News!",
            "certificateCode": null,
            "_count": {
                "luckyNumbers": 0
            }
        }
    ],
    "count": 1,
    "totalPages": 1
}

Request

Query Params
startDate
string <date>
optional
Example:
2024-12-24
endDate
string <date>
optional
Example:
2025-01-30
status
enum<string> 
optional
Allowed values:
ACTIVEFINISHEDSOONFULLPAUSED
Example:
SOON
page
string 
optional
Example:
1

Responses

🟢200OK
application/json
Body
raffles
array [object {19}] 
required
id
integer 
optional
title
string 
optional
statusText
string 
optional
slug
string 
optional
status
string 
optional
startsAt
string 
optional
quotaQuantity
integer 
optional
quotaPrice
string 
optional
endsAt
string 
optional
freeCampaign
boolean 
optional
photoUrl
string 
optional
createdAt
string 
optional
privacy
string 
optional
showProgressBar
boolean 
optional
showPrices
boolean 
optional
isHighlighted
boolean 
optional
subtitle
string 
optional
certificateCode
string  | null 
optional
_count
object 
optional
count
integer 
required
totalPages
integer 
required
Previous
create raffle
Next
get raffle details
Built with