Welcu API v1
Overview
This documentation describes the resources that compose the official Welcu API v1.
Authentication
This API requires an API token per event. This token can be obtained from the integrations menu of your organization.
Every method of this API require an event token which must be passed in the HTTP request Authorization header like:
So for example using curl. Every request must be called like:
Errors
Errors are delivered via HTTP Status Codes along with a JSON payload with the description of the error
401 Unauthorized
This code is returned when the event token is wrong/disabled/empty.
404 Not Found
This code is returned when the API can't find the resource you are querying.
406 Not Acceptable
This code is returned when the change you are trying to perform is not possible
422 Unprocessable Entity
This error is returned when there are errors on the parameters given to the API
Global Auth
You can use a 'company token' to access event's data. Only add a valid 'event_id' to events endpoint.
Example:
Event
Get event information
GET
https://api.welcu.com/v1/event.json
This endpoint allows you to get information about the event including its company and tickets
curl -H 'Authorization: event TOKEN' https://api.welcu.com/v1/event.json
Attendees
Get attendee list
GET
https://api.welcu.com/v1/event/attendees[/:state].json
Using this endpoint you can get the list of attendees along with its ticket
curl -i -H 'Authorization: event TOKEN' \
https://api.welcu.com/v1/event/attendees/checked.json
Path Parameters
Name | Type | Description |
---|---|---|
state | string | To filter list by the attendee state. The available states are: checked: Filter only attendees with checked tickets unchecked: Filter only attendees with unchecked tickets |
Query Parameters
Name | Type | Description |
---|---|---|
since | string | An ISO8601 encoded date to filter attendees updated since the given date |
ticket_id | string | To filter the attendees with tickets for a given ticket_id |
Get attendee by ticket code
GET
https://api.welcu.com/event/attendees/code/:code.json
This endpoint allows you to get the attendee associated to a given ticket code
curl -i -H 'Authorization: event TOKEN' \
https://api.welcu.com/v1/event/attendees/code/SC1F5E6.json
Path Parameters
Name | Type | Description |
---|---|---|
code | string | The ticket code to query |
Check an attendee's ticket
POST
https://api.welcu.com/v1/event/attendees/code/:code/check.json
This endpoint allows you to mark the ticket as checked
curl -i -H 'Authorization: event TOKEN' \
-d 'at=2012-11-16T08:27:05-03:00' \
https://api.welcu.com/v1/event/attendees/code/SC1F5E6.json
Path Parameters
Name | Type | Description |
---|---|---|
code | string | The ticket code to check |
Query Parameters
Name | Type | Description |
---|---|---|
at | string | An ISO8601 encoded date to specify at which time the ticket was checked. The current time is used if left blank. |
Invitations
Get invitations
GET
https://api.welcu.com/v1/event/invitations.json
Using this endpoint you can get the list of attendees along with its tickets
curl -i -H 'Authorization: event TOKEN' \
https://api.welcu.com/v1/event/invitations.json
Get invitation recipients
GET
https:api.welcu.com/v1/event/invitations/:invitation_id/recipients.json
Using this endpoint you can get the list of recipients from an invitation
curl -i -H 'Authorization: event TOKEN' \
https://api.welcu.com/v1/event/invitations/1462/recipients.json
Path Parameters
Name | Type | Description |
---|---|---|
invitation_id | number | To filter the list by invitation. If you don't want to filter by invitation, use invitation_id = all |
Query Parameters
Name | Type | Description |
---|---|---|
string | To filter the recipients by email | |
first_name | string | To filter the recipients by first name |
last_name | string | To filter the recipients by last name |
state | string | To filter the recipients by their state (confirmed, declined, pending) |
Recipient actions
POST
https://api.welcu.com/v1/event/invitations/:invitation_id/recipients/:recipient_id/:action.json
Using this endpoint you can confirm or decline a recipient
curl -i -H 'Authorization: event TOKEN' \
https://api.welcu.com/v1/event/invitations/1462/recipients/974534/decline.json
Path Parameters
Name | Type | Description |
---|---|---|
action | string | The action to perfirm. The available actions are: confirm: Confirm the recipient decline: Decline the recipient |
recipient_id | number | The recipient´s ID |
invitation_id | number | Filter by invitation. If you dont want to filter by invitation, use invitation_id = all |
Company
Get events information
GET
https://api.welcu.com/v1/company.json
Get a list with all events and activities data
curl -i -H 'Authorization: company COMPANY_TOKEN' https://api.welcu.com/v1/company.json
Last updated