Attendees API - EcoEvents

Overview

The Attendees API allows you to manage event registrations and attendee information. Track participant details, dietary preferences, accessibility needs, and carbon offset contributions.

Authentication

All API requests require an API key to be included in the header:

Authorization: Bearer YOUR_API_KEY

Create Attendee

POST /api/attendees

Request

string

required

The ID of the event the attendee is registering for

string

required

Attendee’s first name

string

required

Attendee’s last name

string

required

Attendee’s email address

string

Phone number with country code

string

Company or organization name

string

Job title or position

string

required

Type of ticket (e.g., “general”, “vip”, “early-bird”, “speaker”)

array

Array of dietary preferences (e.g., [“vegetarian”, “vegan”, “gluten-free”, “halal”, “kosher”])

object

Accessibility requirements

Show properties

boolean

Requires wheelchair accessibility

boolean

Requires sign language interpretation

boolean

Requires visual aids or large print materials

string

Other accessibility requirements

object

Carbon offset contribution details

Show properties

boolean

Whether attendee opted for carbon offset

number

Contribution amount in USD

number

Estimated travel distance in kilometers

string

Mode of transportation (“car”, “flight”, “train”, “bus”, “bike”, “walk”)

object

Emergency contact information

Show properties

string

Emergency contact name

string

Emergency contact phone number

string

Relationship to attendee

object

Additional custom fields as key-value pairs

Response

string

Unique identifier for the attendee registration

string

Associated event ID

string

Attendee’s first name

string

Attendee’s last name

string

Attendee’s email

string

Phone number

string

Company name

string

Job title

string

Ticket type

array

Dietary preferences

object

Accessibility requirements

object

Carbon offset details

object

Emergency contact information

object

Custom fields

string

Timestamp when the registration was created

string

Registration status (“confirmed”, “pending”, “cancelled”, “checked-in”)

string

URL to the attendee’s QR code for check-in

string

Unique confirmation code

Example

curl -X POST https://api.ecoevents.com/api/attendees \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "evt_1a2b3c4d5e6f",
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "jane.smith@example.com",
    "phone": "+1-555-0123",
    "company": "GreenTech Solutions",
    "title": "Sustainability Director",
    "ticketType": "general",
    "dietaryPreferences": ["vegetarian"],
    "accessibilityNeeds": {
      "wheelchairAccess": false,
      "signLanguage": false,
      "visualAid": false
    },
    "carbonOffset": {
      "opted": true,
      "amount": 25.00,
      "travelDistance": 150,
      "travelMode": "car"
    },
    "emergencyContact": {
      "name": "John Smith",
      "phone": "+1-555-0124",
      "relationship": "Spouse"
    }
  }'

const response = await fetch('https://api.ecoevents.com/api/attendees', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    eventId: 'evt_1a2b3c4d5e6f',
    firstName: 'Jane',
    lastName: 'Smith',
    email: 'jane.smith@example.com',
    phone: '+1-555-0123',
    company: 'GreenTech Solutions',
    title: 'Sustainability Director',
    ticketType: 'general',
    dietaryPreferences: ['vegetarian'],
    accessibilityNeeds: {
      wheelchairAccess: false,
      signLanguage: false,
      visualAid: false
    },
    carbonOffset: {
      opted: true,
      amount: 25.00,
      travelDistance: 150,
      travelMode: 'car'
    },
    emergencyContact: {
      name: 'John Smith',
      phone: '+1-555-0124',
      relationship: 'Spouse'
    }
  })
});

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

import requests

url = 'https://api.ecoevents.com/api/attendees'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'eventId': 'evt_1a2b3c4d5e6f',
    'firstName': 'Jane',
    'lastName': 'Smith',
    'email': 'jane.smith@example.com',
    'phone': '+1-555-0123',
    'company': 'GreenTech Solutions',
    'title': 'Sustainability Director',
    'ticketType': 'general',
    'dietaryPreferences': ['vegetarian'],
    'accessibilityNeeds': {
        'wheelchairAccess': False,
        'signLanguage': False,
        'visualAid': False
    },
    'carbonOffset': {
        'opted': True,
        'amount': 25.00,
        'travelDistance': 150,
        'travelMode': 'car'
    },
    'emergencyContact': {
        'name': 'John Smith',
        'phone': '+1-555-0124',
        'relationship': 'Spouse'
    }
}

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

Response Example

{
  "id": "att_7g8h9i0j1k2l",
  "eventId": "evt_1a2b3c4d5e6f",
  "firstName": "Jane",
  "lastName": "Smith",
  "email": "jane.smith@example.com",
  "phone": "+1-555-0123",
  "company": "GreenTech Solutions",
  "title": "Sustainability Director",
  "ticketType": "general",
  "dietaryPreferences": ["vegetarian"],
  "accessibilityNeeds": {
    "wheelchairAccess": false,
    "signLanguage": false,
    "visualAid": false
  },
  "carbonOffset": {
    "opted": true,
    "amount": 25.00,
    "travelDistance": 150,
    "travelMode": "car"
  },
  "emergencyContact": {
    "name": "John Smith",
    "phone": "+1-555-0124",
    "relationship": "Spouse"
  },
  "registrationDate": "2026-03-05T11:15:00Z",
  "status": "confirmed",
  "qrCode": "https://api.ecoevents.com/qr/att_7g8h9i0j1k2l",
  "confirmationCode": "ECO-2026-JANE-SMITH-7G8H"
}

List Attendees

GET /api/attendees

Retrieve a paginated list of attendees with optional filtering.

Query Parameters

string

Filter by event ID

integer

default:"1"

Page number for pagination

integer

default:"20"

Number of attendees per page (max 100)

string

Filter by registration status (“confirmed”, “pending”, “cancelled”, “checked-in”)

string

Filter by ticket type

string

Search by name, email, or company

boolean

Filter by carbon offset participation (true/false)

string

default:"registrationDate"

Field to sort by (“registrationDate”, “firstName”, “lastName”, “company”)

string

default:"desc"

Sort order (“asc” or “desc”)

Response

array

Array of attendee objects

object

Pagination information

Show properties

integer

Current page number

integer

Attendees per page

integer

Total number of attendees

integer

Total number of pages

boolean

Whether there is a next page

boolean

Whether there is a previous page

Example

curl -X GET "https://api.ecoevents.com/api/attendees?eventId=evt_1a2b3c4d5e6f&status=confirmed&page=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

const params = new URLSearchParams({
  eventId: 'evt_1a2b3c4d5e6f',
  status: 'confirmed',
  page: '1',
  limit: '10'
});

const response = await fetch(`https://api.ecoevents.com/api/attendees?${params}`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

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

import requests

url = 'https://api.ecoevents.com/api/attendees'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}
params = {
    'eventId': 'evt_1a2b3c4d5e6f',
    'status': 'confirmed',
    'page': 1,
    'limit': 10
}

response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data)

Get Attendee

GET /api/attendees/:id

Retrieve a specific attendee by ID.

Path Parameters

string

required

The unique identifier of the attendee

Response

Returns the full attendee object with all registration details.

Example

curl -X GET https://api.ecoevents.com/api/attendees/att_7g8h9i0j1k2l \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.ecoevents.com/api/attendees/att_7g8h9i0j1k2l', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

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

import requests

url = 'https://api.ecoevents.com/api/attendees/att_7g8h9i0j1k2l'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)
attendee = response.json()
print(attendee)

Update Attendee

PUT /api/attendees/:id

Update attendee information. All fields are optional.

Path Parameters

string

required

The unique identifier of the attendee to update

Request

Accepts the same parameters as Create Attendee, but all fields are optional. Only include fields you want to update.

string

Updated first name

string

Updated last name

string

Updated email address

string

Updated phone number

string

Updated company name

string

Updated job title

string

Updated ticket type

array

Updated dietary preferences

object

Updated accessibility requirements

object

Updated carbon offset details

object

Updated emergency contact

string

Updated registration status (“confirmed”, “pending”, “cancelled”, “checked-in”)

object

Updated custom fields

Response

Returns the updated attendee object.

Example

curl -X PUT https://api.ecoevents.com/api/attendees/att_7g8h9i0j1k2l \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "checked-in",
    "dietaryPreferences": ["vegetarian", "gluten-free"]
  }'

const response = await fetch('https://api.ecoevents.com/api/attendees/att_7g8h9i0j1k2l', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    status: 'checked-in',
    dietaryPreferences: ['vegetarian', 'gluten-free']
  })
});

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

import requests

url = 'https://api.ecoevents.com/api/attendees/att_7g8h9i0j1k2l'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'status': 'checked-in',
    'dietaryPreferences': ['vegetarian', 'gluten-free']
}

response = requests.put(url, headers=headers, json=data)
updated_attendee = response.json()
print(updated_attendee)

Error Responses

All endpoints may return the following error responses:

object

Error details

Show properties

string

Error code (e.g., “INVALID_REQUEST”, “NOT_FOUND”, “DUPLICATE_REGISTRATION”)

string

Human-readable error message

object

Additional error context (optional)

Common Error Codes

Status Code	Error Code	Description
400	INVALID_REQUEST	Invalid request parameters or body
400	EVENT_FULL	Event has reached maximum capacity
401	UNAUTHORIZED	Missing or invalid API key
403	FORBIDDEN	Insufficient permissions
404	NOT_FOUND	Attendee or event not found
409	DUPLICATE_REGISTRATION	Attendee already registered for this event
429	RATE_LIMIT_EXCEEDED	Too many requests
500	INTERNAL_ERROR	Server error

​Overview

​Authentication

​Create Attendee

POST /api/attendees

​Request

​Response

​Example

​Response Example

​List Attendees

GET /api/attendees

​Query Parameters

​Response

​Example

​Get Attendee

GET /api/attendees/:id

​Path Parameters

​Response

​Example

​Update Attendee

PUT /api/attendees/:id

​Path Parameters

​Request

​Response

​Example

​Error Responses

​Common Error Codes

Overview

Authentication

Create Attendee

Request

Response

Example

Response Example

List Attendees

Query Parameters

Response

Example

Get Attendee

Path Parameters

Response

Example

Update Attendee

Path Parameters

Request

Response

Example

Error Responses

Common Error Codes