Get participant by ticket code

GET/participants/ticket-code/{code}

Retrieves participant and ticket information using the ticket code.

This is a public route: it does not need x-api-key or x-api-secret. Anyone who has the ticket code gets the name of the participant, the ticket and its QR code link.

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/ticket-code/CODE'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/ticket-code/CODE', {
  method: 'GET',
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/ticket-code/CODE"

response = requests.get(url)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "participant": {
      "id": "0d2f4b6d-8f0b-4d4f-8b8d-0f2b4d6f0032",
      "name": "João Silva",
      "ticket": {
        "id": "1e3a5c7e-9a1c-4e5a-8c9e-1a3c5e7a0033",
        "code": "ABC123",
        "status": "available",
        "qrCodeLink": "https://cdn.example.com/qrcode.png",
        "valuePaidInCents": 9000,
        "event": {
          "name": "Tech Conference 2026",
          "coverPicture": {
            "name": "cover.png",
            "path": "public/events",
            "url": "https://cdn.example.com/events/cover.png",
            "isPublic": true,
            "extension": "png"
          },
          "inPersonSettings": {
            "localName": "Expo Center",
            "coordinates": {
              "latitude": -23.5505,
              "longitude": -46.6333,
              "altitude": 760,
              "accuracy": 5,
              "timestamp": "2026-05-10T09:00:00.000Z"
            },
            "address": {
              "zipCode": "01001000",
              "street": "Av Paulista",
              "number": "1000",
              "complement": "Sala 1",
              "neighborhood": "Bela Vista",
              "city": "São Paulo",
              "state": "SP"
            }
          },
          "support": {
            "name": "Support Team",
            "email": "support@example.com"
          }
        },
        "batch": {
          "name": "First Batch",
          "valueInCents": 9000,
          "zone": {
            "name": "VIP",
            "days": [
              {
                "id": "d1111111-2222-4333-8444-555555555555",
                "startsAt": "2026-05-10T09:00:00.000Z",
                "endsAt": "2026-05-10T18:00:00.000Z"
              },
              {
                "id": "d2222222-3333-4444-8555-666666666666",
                "startsAt": "2026-05-11T09:00:00.000Z",
                "endsAt": "2026-05-11T18:00:00.000Z"
              }
            ]
          }
        }
      }
    }
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Path parameters

codestringrequired
Unique ticket code. It must have at least 6 characters.

min length 6

Responses

200Participant successfully retrieved.

Participant successfully retrieved.

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- participantobject
  Show child attributesHide child attributes
  idstring · uuid
  namestring
  ticketobject
  Show child attributesHide child attributes
  idstring · uuid
  codestring
  statusstring
  Possible values:availableusedcancelled
  qrCodeLinkstring
  valuePaidInCentsinteger
  eventobject
  Show child attributesHide child attributes
  namestring
  coverPictureobject
  Show child attributesHide child attributes
  namestring
  pathstring
  urlstring
  isPublicboolean
  extensionstring
  inPersonSettingsobject
  Show child attributesHide child attributes
  localNamestring
  coordinatesobject
  Show child attributesHide child attributes
  latitudenumber
  longitudenumber
  altitudenumber
  accuracynumber
  timestampstring · date-time
  addressobject
  Show child attributesHide child attributes
  zipCodestring
  streetstring
  numberstring
  complementstring
  neighborhoodstring
  citystring
  statestring
  supportobject
  Show child attributesHide child attributes
  namestring
  emailstring
  batchobject
  Show child attributesHide child attributes
  namestring
  valueInCentsinteger
  zoneobject
  Show child attributesHide child attributes
  namestring
  daysarray of objects
  Show child attributesHide child attributes
  idstring
  startsAtstring · date-time
  endsAtstring · date-time

400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid param: []

Example:Invalid param: []
errorstring
Bad Request

Example:Bad Request
statusCodeinteger
400

Example:400
errorCodestring
Code that identifies the error. Present only on some errors.

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

statusCodeinteger
HTTP status code.

Example:500
messagestring
Explanation of the error.

Example:Internal Server Error