### Reference code format examples Source: https://help.corsizio.com/article/151-using-reference-codes Examples of valid reference code strings that can be used for tracking. ```text WebsiteOne Example_A77 Example-93 EXAMPLE_SITE example-site.com ``` -------------------------------- ### GET /account Source: https://help.corsizio.com/article/38-api-get-account-details Retrieves the account details and its associated configuration data. ```APIDOC ## GET /account ### Description Use this API endpoint to request the account details with its configuration data. ### Method GET ### Endpoint https://api.corsizio.com/v1/account ### Request Example curl -X GET "https://api.corsizio.com/v1/account" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ### Response #### Success Response (200) - **id** (string) - Account ID - **name** (string) - Account name - **alias** (string) - Account alias - **timeZone** (string) - Account time zone - **currency** (string) - Account currency - **siteUrl** (string) - Account site URL - **contact** (object) - Contact information object - **locations** (array) - List of account locations - **categories** (array) - List of account categories - **ageGroups** (array) - List of age groups - **genders** (array) - List of genders - **levels** (array) - List of levels - **priceRanges** (array) - List of price ranges #### Response Example { "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" } ] } ``` -------------------------------- ### Get Attendee Details Request Source: https://help.corsizio.com/article/44-api-get-attendee-details Example of a cURL request to retrieve attendee information, including optional include and expand parameters. ```bash curl -X GET "https://api.corsizio.com/v1/attendees/588531d5308a374a0209da81?include=payment&expand=event" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ``` -------------------------------- ### Adding ref parameter to URLs Source: https://help.corsizio.com/article/151-using-reference-codes Examples of appending the 'ref' parameter to various Corsizio event and portal URLs. ```text https://my-business.corsizio.com_**/?ref=PartnerA**_ https://site.corsizio.com/portal/6798eba31f21bf41554afabc_**?ref=PartnerA**_ https://biz-one.corsizio.com/event/9867eba31f21bf41554afcba_**?ref=PartnerA**_ https://my-business.corsizio.com/portal/my-business?param1=value1_**&ref=PartnerA**_ ``` -------------------------------- ### Format Blockquotes Source: https://help.corsizio.com/article/65-markdown-formatting Start lines with a right angle-bracket to create a blockquote. ```markdown > This is a fantastic quote that needs your attention. > This line is **still** part of the same quote. ``` -------------------------------- ### Example API Response for Events List Source: https://help.corsizio.com/article/39-api-get-events-list Represents the structure of a successful API response containing account information, pagination details, and an array of event objects. ```json { "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/event/54b067ecd37fb40000537c90", "formUrl": "https://example.corsizio.com/register/54b067ecd37fb40000537c90", "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": "
Sed eget vehicula ligula. Mauris porta molestie bibendum.
\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/event/526832d9353c13324d00000e", "formUrl": "https://example.corsizio.com/register/526832d9353c13324d00000e", "photoUrl": "https://example.corsizio.com/uploads/5255ea833ccc44c65400000d/events/526832d9353c13324d00000e/photo-xJ7u0O4qce.jpg", "mapUrl": null, "summary": null, "summaryHtml": null, "account": "5255ea833ccc44c65400000d" } ] } ``` -------------------------------- ### Retrieve Events List via cURL Source: https://help.corsizio.com/article/39-api-get-events-list Example request to fetch a paginated list of events using an authorization bearer token. ```bash curl -X GET "https://api.corsizio.com/v1/events?limit=2&page=3" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ``` -------------------------------- ### Retrieve Attendees List via cURL Source: https://help.corsizio.com/article/43-api-get-attendees-list Example request to fetch a paginated list of attendees with additional payment data and expanded event details. ```bash curl -X GET "https://api.corsizio.com/v1/attendees?limit=2&page=3&include=payment&expand=event" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ``` -------------------------------- ### Event Details API Response Source: https://help.corsizio.com/article/41-api-get-event-details Example JSON response containing event metadata, pricing, contact information, and related object IDs. ```json { "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/event/55bf96b5d762330433a63760", "formUrl": "https://example.corsizio.com/register/55bf96b5d762330433a63760", "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": "Lorem ipsum dolor sit amet,
\n", "descriptionHtml": "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.
\n", "videoEmbed": null, "maxSpots": null, "contact": { "phone": "555.666.8989", "email": "classes@example.com", "name": "Student Administrator" }, "instructors": [ "5254a331b5957f194c00000d", "5254a331b5957f194c00000f" ], "account": "5255ea833ccc44c65400000d" } ``` -------------------------------- ### GET /events Source: https://help.corsizio.com/article/39-api-get-events-list Retrieves a list of events based on provided query parameters. ```APIDOC ## GET /events ### Description 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. ### Method GET ### Endpoint /events ### Parameters #### Query Parameters - **limit** (Number) - Optional - Limit the results list. Number between 1 and 100. Defaults to 20. - **page** (Number) - Optional - Page number to query for and get more results by the limit per page. Defaults to 1. - **order** (String) - Optional - 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) - Optional - 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) - Optional - Date range to filter query in the form of `FROM_DATE:TO_DATE` (YYYY-MM-DD). - **price** (Number Range) - Optional - Used to return the results filtered by a price range in the form of `FROM:TO`. - **category** (String ID) - Optional - Used to return the results filtered by a specific category ID. - **location** (String ID) - Optional - Used to return the results filtered by a specific location ID. - **age** (String ID) - Optional - Used to return the results filtered by a specific age group ID. - **gender** (String ID) - Optional - Used to return the results filtered by a specific gender ID. - **level** (String ID) - Optional - Used to return the results filtered by a specific level ID. - **search** (String) - Optional - Used to return the results filtered on a word found in the name field of events or an exact event ID. - **include** (String List) - Optional - Used to include more data within the results. Can be any of the following: `details`, `filters`, `stats`, `config`. - **expand** (String List) - Optional - Used to expand and populate specific nodes. Can be any of the following: `filters`, `instructors`, `account`. ### Request Example curl -X GET "https://api.corsizio.com/v1/events?limit=2&page=3" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ``` -------------------------------- ### Attendee List API Response Structure Source: https://help.corsizio.com/article/43-api-get-attendees-list Example JSON response showing attendee registration details, event metadata, and payment status. ```json }, "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": "The purpose of this event...
\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": "Makes a great social event.
\n", "account": "5255ea833ccc44c65400000d" } } ``` -------------------------------- ### GET https://{subdomain}.corsizio.com/register/{id} Source: https://help.corsizio.com/article/47-embedding-registration-form Retrieves the registration form for a specific event to be used as the source for an iframe embed. ```APIDOC ## GET https://{subdomain}.corsizio.com/register/{id} ### Description Embeds a published event's registration form into a website using an HTML iframe. The URL must be used as the `src` attribute of an `iframe` element. ### Method GET ### Endpoint https://{subdomain}.corsizio.com/register/{id}?embed={option,...} ### Parameters #### Path Parameters - **subdomain** (String) - Required - The account’s configured subdomain or the string `site`. - **id** (String) - Required - The event ID to embed. #### Query Parameters - **embed** (String) - Optional - A comma-separated list of options: `noheader` (removes header), `nofooter` (removes branding footer), `nosocial` (hides social icons), `nopadding` (removes page padding). ### Request Example ``` -------------------------------- ### Attendee List API Response Structure Source: https://help.corsizio.com/article/43-api-get-attendees-list Sample JSON response body returned by the GET /attendees endpoint. ```json { "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" ``` -------------------------------- ### Get Attendee Details Response Source: https://help.corsizio.com/article/44-api-get-attendee-details A sample JSON response body containing the full attendee profile, including expanded event data and payment details. ```json { "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": "The purpose of this event...
\n", "account": "5255ea833ccc44c65400000d" } } ``` -------------------------------- ### GET /attendees Source: https://help.corsizio.com/article/43-api-get-attendees-list Retrieves a list of attendees based on provided query parameters. Requires appropriate API Key permissions. ```APIDOC ## GET /attendees ### Description 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. ### Method GET ### Endpoint /attendees ### Parameters #### Query Parameters - **limit** (Number) - Optional - Limit the results list. Number between 1 and 100. Defaults to 20. - **page** (Number) - Optional - Page number to query for and get more results by the limit per page. Defaults to 1. - **status** (String List) - Optional - Restrict the query results to any number of attendee statuses. Defaults to active. Separate multiple values with commas. Prefix with ! to negate. - **date** (Date Range) - Optional - Date range to filter query in the form of FROM_DATE:TO_DATE (YYYY-MM-DD). Dates are inclusive and operate on the "created" date in UTC. - **event** (String ID) - Optional - Used to return the results filtered by a specific event ID. - **coupon** (String ID) - Optional - Used to return the results filtered by a specific coupon code. - **search** (String) - Optional - 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) - Optional - Used to include more data within the results (payment, activity, details). Separate multiple values with commas. - **expand** (String List) - Optional - Used to expand and populate specific nodes (event, account). Separate multiple values with commas. ### Request Example curl -X GET "https://api.corsizio.com/v1/attendees?limit=2&page=3&include=payment&expand=event" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ### Response #### Success Response (200) - **type** (String) - The type of the response object. - **account** (Object) - Account details if expanded. - **paging** (Object) - Paging metadata. - **list** (Array) - List of attendee objects. ``` -------------------------------- ### GET /events/{id} Source: https://help.corsizio.com/article/41-api-get-event-details Retrieves the full details of a specific event. Supports optional parameters to include extra data or expand ID references into full objects. ```APIDOC ## GET /events/{id} ### Description Request details about a single event. You can optionally include additional data or expand specific nodes from their ID value to their full data model representation. ### Method GET ### Endpoint /events/{id} ### Parameters #### Path Parameters - **id** (String) - Required - The event ID to request its full details. #### Query Parameters - **include** (String List) - Optional - Used to include more data within the results. Options: `filters`, `stats`, `attendees`, `payment`. Separate multiple values with commas. - **expand** (String List) - Optional - Used to expand specific nodes to their full data objects. Options: `filters`, `instructors`, `account`. Separate multiple values with commas. ### Request Example curl -X GET "https://api.corsizio.com/v1/events/55bf96b5d762330433a63760" -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ### Response #### Success Response (200) - **id** (String) - The event ID - **name** (String) - The event name - **startDate** (String) - Event start date - **endDate** (String) - Event end date - **instructors** (Array) - List of instructor IDs - **account** (String) - Account ID #### Response Example { "id": "55bf96b5d762330433a63760", "name": "Great Health Workshop 2016", "startDate": "2016-08-01T18:00:00.000Z", "endDate": "2016-08-02T00:00:00.000Z", "instructors": [ "5254a331b5957f194c00000d", "5254a331b5957f194c00000f" ], "account": "5255ea833ccc44c65400000d" } ``` -------------------------------- ### GET /attendees/{id} Source: https://help.corsizio.com/article/44-api-get-attendee-details Retrieves the full details of a specific attendee. You can optionally include additional data or expand related objects by providing the appropriate query parameters. ```APIDOC ## GET /attendees/{id} ### Description Use this API endpoint to request details about a single attendee along with the ability to include additional data that is 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. ### Method GET ### Endpoint /attendees/{id} ### Parameters #### Path Parameters - **id** (String) - Required - The attendee ID to request its full details. #### Query Parameters - **include** (String List) - Optional - 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) - Optional - 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. ### Request Example curl -X GET "https://api.corsizio.com/v1/attendees/588531d5308a374a0209da81?include=payment&expand=event" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ### Response #### Success Response (200) - **id** (String) - The attendee ID. - **name** (String) - Full name of the attendee. - **email** (String) - Email address of the attendee. - **status** (String) - Current status of the attendee. - **created** (String) - Creation timestamp. - **updated** (String) - Last update timestamp. #### Response Example { "id": "588531d5308a374a0209da81", "name": "Jamie Garland", "email": "jamie@example.com", "status": "active", "created": "2017-01-22T22:27:33.034Z", "updated": "2017-02-14T20:15:22.250Z" } ``` -------------------------------- ### Create Hyperlinks Source: https://help.corsizio.com/article/65-markdown-formatting Format links using square brackets for the text and parentheses for the URL. Ensure there are no spaces between the brackets and parentheses. ```markdown This is a [link text](http://www.example.com) within content. ``` -------------------------------- ### Format Headings with Underlines Source: https://help.corsizio.com/article/65-markdown-formatting Alternative syntax for Heading 1 and Heading 2 using equal signs or hyphens. ```markdown Heading 1 ======== Heading 2 --------------- ``` -------------------------------- ### Create Tables Source: https://help.corsizio.com/article/65-markdown-formatting Define tables using pipes and hyphens. Colons can be added to the header row to specify column alignment. ```markdown | Col1 | Col2 | Col3 | | --- | --- | --- | | Cell | Cell | Cell | | Cell | Cell | Cell | ``` ```markdown | Left | Center | Right | | :--- | :----: | ----: | | Cell | Cell | Cell | | Cell | Cell | Cell | ``` ```markdown A | B | C --- | --- | --- **value** | _value_ | value **value** | _value_ | value ``` -------------------------------- ### Create Lists Source: https://help.corsizio.com/article/65-markdown-formatting Use numbers for ordered lists and asterisks, hyphens, or plus signs for unordered lists. Indentation can be used for sub-lists and paragraphs. ```markdown 1. First ordered list item 2. Another item ⋅⋅⋅* Unordered sub-list 1. Actual numbers don't matter, just that it's a number ⋅⋅⋅1. Ordered sub-list 4. Here is another item ⋅⋅⋅You can have properly indented paragraphs within list ⋅⋅⋅items. Notice the blank line above, and the leading spaces (at least one, ⋅⋅⋅but we'll use three here to also align the raw Markdown). ⋅⋅⋅To have a line break without a paragraph, you will need ⋅⋅⋅to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph. * Unordered list can use asterisks - or hyphens + or pluses ``` -------------------------------- ### Request Account Details via cURL Source: https://help.corsizio.com/article/38-api-get-account-details Use this cURL command to retrieve account details. Replace {YOUR_API_SECRET_KEY} with your actual API secret key. ```bash curl -X GET "https://api.corsizio.com/v1/account" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ``` -------------------------------- ### Insert Images Source: https://help.corsizio.com/article/65-markdown-formatting Embed images using an exclamation mark followed by brackets and parentheses. Ensure there are no spaces between the brackets and parentheses. ```markdown  ``` -------------------------------- ### Retrieve Event Details via cURL Source: https://help.corsizio.com/article/41-api-get-event-details Use this request to fetch event details. Replace {YOUR_API_SECRET_KEY} with your actual API key. ```bash curl -X GET "https://api.corsizio.com/v1/events/55bf96b5d762330433a63760" \ -H "Authorization: Bearer {YOUR_API_SECRET_KEY}" ``` -------------------------------- ### Format Headings with Hash Symbols Source: https://help.corsizio.com/article/65-markdown-formatting Use hash symbols to define heading levels. Ensure blank lines are present above and below the heading for proper rendering. ```markdown # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ``` -------------------------------- ### Apply Bold and Italics Source: https://help.corsizio.com/article/65-markdown-formatting Use double asterisks or underscores for bold text, and single asterisks or underscores for italics. ```markdown Wrap text with double **asterisks** or __underscores__ to bold. Wrap text with single *asterisk* or _underscore_ to italicize. ``` -------------------------------- ### Account Details JSON Response Source: https://help.corsizio.com/article/38-api-get-account-details The response body contains account configuration data including contact info, locations, and various metadata categories. ```json { "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" } ] } ``` -------------------------------- ### Embed Registration Form with Iframe and Message Listener Source: https://help.corsizio.com/article/47-embedding-registration-form Uses an iframe to display the registration form and a script to handle dynamic height adjustments and scrolling via postMessage. ```html ``` -------------------------------- ### Insert Horizontal Lines Source: https://help.corsizio.com/article/65-markdown-formatting Use three or more consecutive equal-signs, hyphens, or underscores to create a horizontal rule. ```markdown === --- ___ ``` -------------------------------- ### Embed Image via HTML Source: https://help.corsizio.com/article/88-providing-or-adding-links-to-external-files Use this HTML tag in the code view to display an image from a publicly accessible URL. ```html
```
--------------------------------
### Authentication
Source: https://help.corsizio.com/article/37-api-endpoint-authentication
All API requests must be authenticated using a secret access token provided in the Authorization header.
```APIDOC
## Authentication
### Description
All requests to the Corsizio API must be authenticated using a secret access token. This token is provided in the HTTP header of every request.
### Authentication Method
- **Header**: Authorization
- **Value**: Bearer {YOUR_API_SECRET_KEY}
### Root Endpoint
https://api.corsizio.com/v1
### Requirements
- Enable API integration in Account Integration Settings.
- Obtain the API Secret Access Key.
- Grant appropriate permissions to the API Key within integration settings.
```
--------------------------------
### Embed Social Media Image Link via HTML
Source: https://help.corsizio.com/article/61-integrate-corsizio-with-social-media
Use this HTML snippet in the Code view of the event description editor to add a linked social media icon. Ensure you replace the placeholder URLs and adjust dimensions as required.
```html