Root Endpoint

https://api.corsizio.com/v1

You must enable the API integration from inside your Account Integration Settings. Once you do so, you will be able to copy and store the API Secret Access Key to use on all API requests as outlined below within the authentication section. This step is required.

All API endpoints must use the root path above with the https request protocol.

Authentication

We use secret access tokens to authorize the API requests and authenticate to the account which will be identified using the signed access token. Every request to the API must include this secret access token in a specific HTTP header.

To authenticate, just add the HTTP header Authorization along with a value of Bearer {YOUR_API_SECRET_KEY}.

Be sure to replace the {YOUR_API_SECRET_KEY} with the account’s key found within the app under Account Integration Settings.

You also must grant the right permissions to your API Key from within the integration settings to be able to query the API for the information you desire.

Get Account Details

GET /account

Use this API endpoint to request the account details with its configuration data.

curl -X GET "https://api.corsizio.com/v1/account" \
     -H "Authorization: Bearer {YOUR_API_SECRET_KEY}"
{
  "id": "5255ea833ccc44c65400000d",
  "name": "Example Account",
  "alias": "example",
  "timeZone": "America/Toronto",
  "currency": "usd",
  "siteUrl": "https://example.corsizio.com",
  "contact": {
    "phone": "555.666.8989",
    "email": "classes@example.com",
    "name": "Student Administrator"
  },
  "locations": [
    {
      "city": "Toronto",
      "country": "Canada",
      "label": "First Canadian Place, 100 King St W, Toronto, Ontario, Canada",
      "name": "First Canadian Place",
      "state": "Ontario",
      "street": "100 King St W",
      "zip": "M5X 1A9",
      "id": "526a918895e5ca2a6200000d"
    },
    {
      "label": "Super Hall, 555 Yonge Street",
      "name": "Super Hall",
      "street": "555 Yonge Street",
      "id": "526a98d9072671876200000d"
    }
  ],
  "categories": [
    {
      "label": "Healthy & Well"
      "id": "525da79b9786571a1d00000e",
    }
  ],
  "ageGroups": [
    {
      "label": "Child",
      "id": "525f20c3ca86697a2f00001c"
    },
    {
      "label": "Adult",
      "id": "525f20c3ca86697a2f00001a"
    }
  ],
  "genders": [
    {
      "label": "Men",
      "id": "525f20c3ca86697a2f03401c"
    },
    {
      "label": "Women",
      "id": "525f20c3ca86697a2f03401a"
    }
  ],
  "levels": [
    {
      "label": "Level 1",
      "id": "525f1ffaca86697a2f000012"
    },
    {
      "label": "Level 2",
      "id": "525f1ffaca86697a2f000011"
    }
  ],
  "priceRanges": [
    {
      "label": "Free",
      "from": 0,
      "to": 0,
      "value": "0:0",
      "id": "535d6fb4097e133f57000011"
    },
    {
      "label": "Under $50",
      "to": 50,
      "from": null,
      "value": "under:50",
      "id": "5273c5825b7355040300000e"
    },
    {
      "label": "$51 — $100",
      "from": 51,
      "to": 100,
      "value": "51:100",
      "id": "5260895b36d5ba9d3600000d"
    },
    {
      "label": "Over $101",
      "from": 101,
      "to": null,
      "value": "101:over",
      "id": "535d6e1b9f5368014a000013"
    }
  ]
}

Get Events List

GET /events

Use this API endpoint to query the list of events 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.

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
order String Sort order to return the results list in. Can be one of the following: startDate, endDate, or created. For descending order just add - to your choice like -endDate. Defaults to -startDate
status String Restrict the query results to a specific event status. Can be one of the following: any, published, draft, archived, or deleted. Defaults to published
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 query in UTC time.
price Number Range Used to return the results filtered by a price range in the form of FROM:TO. They must be positive numbers. Examples would be: 50:200 for prices between $50 to $200, :300 for $300 and under, 1000 for $1,000 and over.
category String ID Used to return the results filtered by a specific category ID from account setup.
location String ID Used to return the results filtered by a specific location ID from account setup.
age String ID Used to return the results filtered by a specific age group ID from account setup.
gender String ID Used to return the results filtered by a specific gender ID from account setup.
level String ID Used to return the results filtered by a specific level ID from account setup.
search String Used to return the results filtered on a word found in the name field of events or an exact event 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: details, filters, stats, config. 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: filters, instructors, account. Separate multiple values with commas.
curl -X GET "https://api.corsizio.com/v1/events?limit=2&page=3" \
     -H "Authorization: Bearer {YOUR_API_SECRET_KEY}"
{
  "type": "events",
  "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": "54b067ecd37fb40000537c90",
      "name": "Foster The Web Conference",
      "startDate": "2015-07-25T18:00:00.000Z",
      "endDate": "2015-07-26T00:00:00.000Z",
      "registrationCloseDate": "2015-07-25T18:00:00.000Z",
      "displayDate": "Saturday, July 25, 2015, 2 - 8 PM (EDT)",
      "timeZone": "America/Toronto",
      "location": "Super Hall, 555 Yonge Street",
      "priceFrom": 200,
      "priceTo": 260,
      "prices": [
        {
          "price": 260,
          "earlyPrice": 200,
          "earlyBefore": "2015-06-22T00:00:00.000Z"
        }
      ],
      "currency": "usd",
      "pageUrl": "https://example.corsizio.com/c/54b067ecd37fb40000537c90",
      "formUrl": "https://example.corsizio.com/c/54b067ecd37fb40000537c90/register",
      "photoUrl": null,
      "mapUrl": "https://www.google.com/maps/place/555+Yonge+Street",
      "mapUrl": "https://www.google.com/maps/place/Super+Hall,+555+Yonge+Street",
      "summary": "Sed eget vehicula ligula. **Mauris porta molestie bibendum.**",
      "summaryHtml": "<p>Sed eget vehicula ligula. <b>Mauris porta molestie bibendum.</b></p>\n",
      "account": "5255ea833ccc44c65400000d"
    },
    {
      "id": "526832d9353c13324d00000e",
      "name": "Show Your Colors Art Class",
      "startDate": "2014-06-28T23:00:00.000Z",
      "endDate": "2014-06-29T02:00:00.000Z",
      "registrationCloseDate": "2014-06-28T23:00:00.000Z",
      "displayDate": "Saturday, June 28, 2014, 7 - 10 PM (EDT)",
      "timeZone": "America/Toronto",
      "location": null,
      "priceFrom": 77,
      "priceTo": 88,
      "prices": [
        {
          "price": 77,
          "label": "Youth Admission"
        },
        {
          "price": 88,
          "label": "Adult Admission"
        }
      ],
      "currency": "usd",
      "pageUrl": "https://example.corsizio.com/c/526832d9353c13324d00000e",
      "formUrl": "https://example.corsizio.com/c/526832d9353c13324d00000e/register",
      "photoUrl": "https://example.corsizio.com/uploads/5255ea833ccc44c65400000d/events/526832d9353c13324d00000e/photo-xJ7u0O4qce.jpg",
      "mapUrl": null,
      "summary": null,
      "summaryHtml": null,
      "account": "5255ea833ccc44c65400000d"
    }
  ]
}

Get Event Details

GET /events/{id}

Use this API endpoint to request details about a single event 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.

If you need the attendees list for the event, then use the include parameter to ask for the attendees and optionally the payment information for each attendee. Only use this option if you truly need that information. You also must have given the right permissions to your API Key from within your account integration settings.

Path Parameters

Param Type Description
id String The event ID to request its full details.

Query Parameters

Param Type Description
include String List Used to include more data within the results that are normally not provided by default. Can be any of the following: filters, stats, attendees, payment. 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: filters, instructors, account. Separate multiple values with commas.
curl -X GET "https://api.corsizio.com/v1/events/55bf96b5d762330433a63760" \
     -H "Authorization: Bearer {YOUR_API_SECRET_KEY}"
{
  "id": "55bf96b5d762330433a63760",
  "name": "Great Health Workshop 2016",
  "startDate": "2016-08-01T18:00:00.000Z",
  "endDate": "2016-08-02T00:00:00.000Z",
  "registrationCloseDate": "2016-08-01T18:00:00.000Z",
  "displayDate": "Monday, August 1, 2 - 8 PM (EDT)",
  "timeZone": "America/Toronto",
  "location": "First Canadian Place, 100 King St W, Toronto, Ontario, Canada",
  "priceFrom": 1200,
  "priceTo": 2100,
  "prices": [
    {
      "price": 1400,
      "label": "Saturday Only",
      "earlyPrice": 1200,
      "earlyBefore": "2016-07-14T00:00:00.000Z"
    },
    {
      "price": 2100,
      "label": "Full Weekend"
    }
  ],
  "currency": "usd",
  "pageUrl": "https://example.corsizio.com/c/55bf96b5d762330433a63760",
  "formUrl": "https://example.corsizio.com/c/55bf96b5d762330433a63760/register",
  "photoUrl": "https://example.corsizio.com/uploads/5255ea833ccc44c65400000d/events/55bf96b5d762330433a63760/photo-mJGnQkGHe.jpg",
  "mapUrl": "https://www.google.com/maps/place/100+King+St+W,+Toronto,+Ontario,+Canada,+M5X+1A9",
  "summaryHtml": "<p>Lorem ipsum dolor sit amet,</p>\n",
  "descriptionHtml": "<p>Nulla quis interdum orci. Vestibulum condimentum, felis vestibulum tincidunt mollis, tellus ligula dictum nunc, id consectetur massa augue nec turpis. Aliquam vel facilisis eros, a pellentesque risus. Mauris tristique, tellus non ullamcorper volutpat, ipsum dui laoreet nulla, in vehicula neque purus quis lectus. Suspendisse ut pulvinar risus, eu maximus mi. Donec lorem lectus, lacinia id purus sed, mollis pellentesque odio.</p>\n",
  "videoEmbed": null,
  "maxSpots": null,
  "contact": {
    "phone": "555.666.8989",
    "email": "classes@example.com",
    "name": "Student Administrator"
  },
  "instructors": [
    "5254a331b5957f194c00000d",
    "5254a331b5957f194c00000f"
  ],
  "account": "5255ea833ccc44c65400000d"
}

Get Attendees List

GET /attendees

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 lookup 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, 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: owning,!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 query 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.
curl -X GET "https://api.corsizio.com/v1/attendees?limit=2&page=3&include=payment&expand=event" \
     -H "Authorization: Bearer {YOUR_API_SECRET_KEY}"
{
  "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/c/57f672e54c6828710009a86e",
        "formUrl": "https://example.corsizio.com/c/57f672e54c6828710009a86e/register",
        "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/c/58c6fef561ecfc02dafeb328",
        "formUrl": "https://example.corsizio.com/c/58c6fef561ecfc02dafeb328/register",
        "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"
      }
    }
  ]
}

Get Attendee Details

GET /attendees/{id}

Use this API endpoint to request details about a single attendee 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 lookup attendees.

Path Parameters

Param Type Description
id String The attendee ID to request its full details.

Query Parameters

Param Type Description
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.
curl -X GET "https://api.corsizio.com/v1/attendees/588531d5308a374a0209da81?include=payment&expand=event" \
     -H "Authorization: Bearer {YOUR_API_SECRET_KEY}"
{
  "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/c/57f672e54c6828710009a86e",
    "formUrl": "https://example.corsizio.com/c/57f672e54c6828710009a86e/register",
    "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"
  }
}

Experience Corsizio

In minutes you can start accepting registrations, online payments, and feedback for your classes, courses, workshops and similar events.

Visit Website