Corsizio

https://help.corsizio.com
Admin
Corsizio is an online event registration and payment web platform designed to help individuals and...
Tokens:52,517
Snippets:821
Trust Score:8.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### 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**_
```

--------------------------------

### 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 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": "<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/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"
    }
  ]
}
```

--------------------------------

### 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}"
```

--------------------------------

### 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

```
Tokens:
Raw