API Docs

All endpoints work only on HTTPS (and temporarily use "www" subdomain due to certificates configuration).
In order to authenticate with the server, an "Auth-Token" request header needs to be sent with your API token.
Events and Guests can have custom fields defined at the account level. Log In and check this page again in order to see these fields, they will appear at the end of the attributes list.

All endpoints return a status key in the JSON response with values as follows:

success: Successful execution returning html status code 200.
fail: There was an error in the input parameters but execution was correct returning html status code 200 and a data key with the error.
error: There was an error in the execution. Like system error, wrong URL, or permissions error. In this case the status code will not be 200.

Events

Create Event

URL

https://www.badgestic.com/v1/events

Method

POST

Parameters

name
description Optional
utc_offset Optional
starts_at Datetime Specification Formats
ends_at Datetime Specification Formats

CURL example


                  curl -d 'name=Test From API&description=works?&utc_offset=-5&starts_at_year=2023&starts_at_month=10&starts_at_day=10&starts_at_hour=12&starts_at_minute=00&ends_at_year=2023&ends_at_month=10&ends_at_day=11&ends_at_hour=12&ends_at_minute=00' -H 'Auth-Token: <auth token>' https://www.badgestic.com/v1/events

Returns on success

status: success
data: {'event_id': <id of created event>}

Returns on fail

status: fail
data: [['attr1', 'error_code1'], ['attr2', 'error_code2'], ...]

Update Event

URL

https://www.badgestic.com/v1/events/<event id>

Method

PUT

Parameters

name
description
utc_offset
starts_at Datetime Specification Formats
ends_at Datetime Specification Formats

(Only send parameters that need to be updated)

CURL example


                  curl -d 'name=Test From API (mod)&utc_offset=2' -H 'Auth-Token: <auth token>' -X PUT https://www.badgestic.com/v1/events/<event id>

Returns on success

status: success
data: null

Returns on fail

status: fail
data: [['attr1', 'error_code1'], ['attr2', 'error_code2'], ...]

Delete Event

URL: https://www.badgestic.com/v1/events/<event id>
Method: DELETE
CURL example: curl -H 'Auth-Token: <auth token>' -X DELETE https://www.badgestic.com/v1/events/<event id>

Returns

status: success
data: null

Show Event

URL: https://www.badgestic.com/v1/events/<event id>
Method: GET
CURL example: curl -H 'Auth-Token: <auth token>' https://www.badgestic.com/v1/events/<event id>

Returns

status: success
data: { 'event': {Event data}, 'guests': [ {Guest 1 data}, {Guest 2 data}, ..., {Guest N data} ] }

Guests

Create Guest

URL

https://www.badgestic.com/v1/events/<event id>/guests

Method

POST

Parameters

first_name
last_name
email Optional
active Optional; Default: 'true'; Possible Values: 'true' | 'false'

CURL example


                  curl -d 'first_name=John&last_name=Smith' -H 'Auth-Token: <auth token>' https://www.badgestic.com/v1/events/<event id>/guests

Returns on success

status: success
data: {'guest_id': <id of created guest>}

Returns on fail

status: fail
data: [['attr1', 'error_code1'], ['attr2', 'error_code2'], ...]

Update Guest

URL

https://www.badgestic.com/v1/guests/<guest id>

Method

PUT

Parameters

first_name
last_name
email Optional
active Possible Values: 'true' | 'false'

(Only send parameters that need to be updated)

CURL example


                  curl -d 'first_name=John&last_name=Smith Johnson' -H 'Auth-Token: <auth token>' -X PUT https://www.badgestic.com/v1/guests/<guest id>

Returns on success

status: success
data: null

Returns on fail

status: fail
data: [['attr1', 'error_code1'], ['attr2', 'error_code2'], ...]

Delete Guest

URL: https://www.badgestic.com/v1/guests/<guest id>
Method: DELETE
CURL example: curl -H 'Auth-Token: <auth token>' -X DELETE https://www.badgestic.com/v1/guests/<guest id>

Returns

status: success
data: null

Other

QR Code

This method is not technically part of the API. It doesn't need authentication and it is not versioned. It returns the QR code image for a guest.

URL: https://www.badgestic.com/guests/<guest_id>/qr_code
Method: GET

Returns

PNG image: Guest's QR code.

QR Code URL (Deprecated)

This method is not technically part of the API. It doesn't need authentication and it is not versioned. It returns a plain string with the qr code url if available, otherwise an empty string.

URL: https://www.badgestic.com/guests/<guest_id>/qr_code_url
Method: GET

Returns

Plain String: <QR Code url> or empty string if qr code is not available.