API: Get Attendees List
Use this API endpoint to query the list of attendees from the account using multiple query string parameter filters, along with the ability to include additional data that are not normally included by default. Also, you will have the ability to expand certain data types from their ID value to their full data model representation during the parsing of your API request.
Note: You must have given the right permissions to your API Key from within your account integration settings to look up attendees.
GET /attendees
Query Parameters
| Param | Type | Description |
|---|---|---|
limit |
Number | Limit the results list. Number between 1 and 100. Defaults to 20 |
page |
Number | Page number to query for and get more results by the limit per page. Defaults to 1 |
status |
String List | Restrict the query results to any number of attendee statuses. Can be any of the following: any, active, waiting, archived, deleted, manual, attended, absent, payment, paid, owing, early, deposit, offline, exempt, refunded, canceled. Defaults to active. Separate multiple values with commas. To negate or exclude a status just prefix it with ! like so: owing,!canceled |
date |
Date Range | Date range to filter query in the form of FROM_DATE:TO_DATE where the date format is YYYY-MM-DD. You can omit either side of the range too. Examples would be: 2017-06-24 or 2017-06-01:2017-06-30 or even just a portion of the date like only a year 2016 or a month range 2016-11:2016-11. You can omit the from date as well to only filter the end dates like :2017-02-18. Dates are inclusive and operate on the "created" date of records in UTC time. |
event |
String ID | Used to return the results filtered by a specific event ID. |
coupon |
String ID | Used to return the results filtered by a specific coupon code. |
search |
String | Used to return the results filtered on a word found in the name, email, or phone fields of an attendee or an exact attendee ID. |
include |
String List | Used to include more data within the results that are normally not provided by default. Can be any of the following: payment, activity, details. Separate multiple values with commas. |
expand |
String List | Used to expand and populate specific nodes within the results which are usually just IDs to their full data objects. Can be any of the following: event, account. Separate multiple values with commas. |
Example Request
curl -X GET "https://api.corsizio.com/v1/attendees?limit=2&page=3&include=payment&expand=event" \
-H "Authorization: Bearer {YOUR_API_SECRET_KEY}"
Example Response
{
"type": "attendees",
"account": {
"id": "5255ea833ccc44c65400000d",
"name": "Example Account",
"alias": "example",
"timeZone": "America/Toronto",
"currency": "usd",
"siteUrl": "https://example.corsizio.com"
},
"paging": {
"page": 3,
"limit": 2,
"count": 2,
"more": true
},
"list": [
{
"id": "588531d5308a374a0209da81",
"name": "Jamie Garland",
"firstName": "Jamie",
"lastName": "Eight",
"email": "jamie@example.com",
"phone": null,
"address": "116 SW Clay St, Portland, OR 97201, USA",
"note": "Note from attendee submitted upon registration",
"remark": "Internal private note about the attendee",
"status": "active",
"manual": false,
"attended": null,
"transferred": null,
"canceled": null,
"created": "2017-01-22T22:27:33.034Z",
"updated": "2017-02-14T20:15:22.250Z",
"accountId": "5255ea833ccc44c65400000d",
"eventId": "57f672e54c6828710009a86e",
"coupon": {},
"feedback": {},
"fields": [
{
"label": "Favorite Color",
"value": "blue"
},
{
"label": "Tell us why you want to enroll",
"value": "I want to network with others"
}
],
"addons": [],
"payment": {
"label": "Association Member",
"description": "Fresh Off The Press Event",
"refunded": false,
"early": false,
"paid": "2017-01-22T22:27:32.000Z",
"asked": null,
"changed": "2017-01-29T13:49:57.811Z",
"deposit": false,
"offline": false,
"exempt": false,
"refund": 0,
"pending": 0,
"amount": 45.2,
"full": 45.2,
"fees": 3.32,
"taxes": 5.2,
"tax": 13,
"subtotal": 40,
"addons": 0,
"discount": 0,
"price": 40,
"currency": "usd"
},
"transactions": [
{
"method": "credit-card",
"chargeId": "ch_9yrXqwW5yByXYZ",
"currency": "usd",
"amount": 45.2,
"fees": 3.32,
"card": {
"name": "Jamie Garland",
"brand": "Visa",
"last4": "4242",
"country": "US"
},
"refund": 0,
"refunds": [],
"refunded": false,
"paid": true,
"created": "2017-01-22T22:27:32.000Z"
}
],
"event": {
"id": "57f672e54c6828710009a86e",
"name": "Fresh Off The Press Event",
"startDate": "2017-04-06T17:00:00.000Z",
"endDate": "2017-04-22T21:00:00.000Z",
"registrationCloseDate": "2017-04-22T21:00:00.000Z",
"displayDate": "Thursday, April 6, 10 AM - Saturday, April 22, 2 PM (EDT)",
"timeZone": "America/Toronto",
"location": "Super Hall, 555 Yonge Street",
"priceFrom": 40,
"priceTo": 50,
"prices": [
{
"price": 40,
"label": "Association Member"
},
{
"price": 50,
"label": "General"
}
],
"currency": "usd",
"pageUrl": "https://example.corsizio.com/event/57f672e54c6828710009a86e",
"formUrl": "https://example.corsizio.com/register/57f672e54c6828710009a86e",
"photoUrl": null,
"mapUrl": "https://www.google.com/maps/place/555+Yonge+Street",
"summary": "The purpose of this event...",
"summaryHtml": "<p>The purpose of this event...</p>\n",
"account": "5255ea833ccc44c65400000d"
}
},
{
"id": "58cc269d3ad45100a79d12a7",
"name": "Fred Julianozo",
"firstName": "Fred",
"lastName": "Julianozo",
"email": "fred@example.com",
"phone": "444.665.3455",
"address": null,
"note": null,
"remark": null,
"status": "active",
"manual": true,
"attended": null,
"transferred": null,
"canceled": null,
"created": "2017-03-17T18:10:37.006Z",
"updated": "2017-03-17T18:10:37.010Z",
"accountId": "5255ea833ccc44c65400000d",
"eventId": "58c6fef561ecfc02dafeb328",
"coupon": {},
"feedback": {},
"fields": [],
"addons": [],
"payment": {
"label": null,
"description": "My Greatest Event Yet Ever",
"paid": null,
"asked": null,
"changed": null,
"deposit": false,
"offline": true,
"exempt": false
"early": false,
"refund": 0,
"pending": 450,
"amount": 0,
"full": 450,
"fees": 0,
"taxes": 0,
"tax": 0,
"subtotal": 450,
"addons": 0,
"discount": 0,
"price": 450,
"currency": "usd"
},
"transactions": [],
"event": {
"id": "58c6fef561ecfc02dafeb328",
"name": "My Greatest Event Yet Ever",
"startDate": "2017-03-31T21:00:00.000Z",
"endDate": "2017-04-01T00:00:00.000Z",
"registrationCloseDate": "2017-03-31T21:00:00.000Z",
"displayDate": "Friday, March 31, 5 - 8 PM (EDT)",
"timeZone": "America/Toronto",
"location": "First Canadian Place, 100 King St W, Toronto, Ontario, Canada",
"priceFrom": 450,
"priceTo": 450,
"prices": [
{
"price": 450
}
],
"currency": "usd",
"pageUrl": "https://example.corsizio.com/event/58c6fef561ecfc02dafeb328",
"formUrl": "https://example.corsizio.com/register/58c6fef561ecfc02dafeb328",
"photoUrl": null,
"mapUrl": "https://www.google.com/maps/place/100+King+St+W,+Toronto,+Ontario,+Canada,+M5X+1A9",
"summary": "Makes a great social event.",
"summaryHtml": "<p>Makes a great social event.</p>\n",
"account": "5255ea833ccc44c65400000d"
}
}
]
}