Filter participants

POST/participants/filter

Retrieves a paginated list of participants based on filters. This is an authenticated route. It supports filtering by batches, zones, event days, ticket status, and a search field that matches participant name, email, document, or ticket code.

Request

curl --request POST \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/filter' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
  "eventExternalReferenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "batchIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "zoneIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "eventDayIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "participantIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "status": [
    "available"
  ],
  "field": "string"
}'

Generated from the schema

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/filter', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "eventExternalReferenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "batchIds": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "zoneIds": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "eventDayIds": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "participantIds": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "status": [
      "available"
    ],
    "field": "string"
  }),
});

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

Generated from the schema

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/filter"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}
payload = {
    "eventExternalReferenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "batchIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    ],
    "zoneIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    ],
    "eventDayIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    ],
    "participantIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    ],
    "status": [
        "available",
    ],
    "field": "string",
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Generated from the schema

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "9c1e3a5c-7e9a-4c3e-8a7c-9e1a3c5e0031",
        "name": "João Silva",
        "email": "joao.silva@example.com",
        "internationalId": "INT-123456",
        "document": {
          "type": "CPF",
          "number": "12345678900"
        },
        "phone": {
          "areaCode": "+55",
          "ddd": "11",
          "number": "999999999",
          "isMobile": true
        },
        "ticketStatus": "available",
        "code": "ABC123",
        "hasCheckIn": false
      }
    ],
    "limit": 10,
    "currentPage": 1,
    "nextPage": 2,
    "totalPages": 50,
    "totalDocs": 500,
    "hasNext": true
  }
}

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

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

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

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.