Events

get
All Events

https://yourcompany.sport-keeper.com/api/v1/events
Retrieve all events
Request
Response
Path Parameters
page
optional
integer
Results are paginated.
Headers
Authorization
required
string
Auth token
200: OK
Returns an array of events. Only the first 20 are returned. Passing the page param will paginate the results.
[
{
"id": 1,
"name": "New Event",
"description": "its awesome",
"start_date": "2019-02-07T12:00:00.000-05:00",
"end_date": "2019-02-08T12:00:00.000-05:00",
"all_day": null,
"status": "published",
"image_data": null,
"created_at": "2019-02-06T19:43:26.052-05:00",
"updated_at": "2019-02-06T19:43:26.052-05:00",
"recurring": {},
"recurring_until": null,
"seats": null,
"price_cents": null,
"public": true,
"currency": "USD"
}
]

get
Show Event

https://yourcompany.sport-keeper.com/api/v1/events/:id
Retrieve a single event
Request
Response
Headers
Authorization
required
string
Auth token
200: OK
{
"id": 1,
"name": "New Event",
"description": "its awesome",
"start_date": "2019-02-07T12:00:00.000-05:00",
"end_date": "2019-02-08T12:00:00.000-05:00",
"all_day": null,
"status": "published",
"image_data": null,
"created_at": "2019-02-06T19:43:26.052-05:00",
"updated_at": "2019-02-06T19:43:26.052-05:00",
"recurring": {},
"recurring_until": null,
"seats": null,
"price_cents": null,
"public": true,
"currency": "USD"
}
404: Not Found
null

post
Create Event

https://yourcompany.sport-keeper.com/v1/events
Request
Response
Headers
Authorization
required
string
Auth Token
Form Data Parameters
name
required
string
Name of the event.
description
required
string
A description for the event.
start_date
required
integer
Event start date in datetime format.
end_date
required
integer
Event end date in datetime format.
all_day
optional
boolean
Does this event last all day?
status
optional
integer
0 - draft, 1 - published, 2 - booked
recurring
optional
object
Hash of recurring event attributes.
recurring_until
optional
integer
Recurs until in datetime format.
seats
optional
integer
Maximum number of seats for this event.
price_cents
optional
integer
Price of event in cents if charging for event.
public
optional
boolean
Is this event public? Will appear to public. If private, will be considered internal and not visible to the public.
200: OK
{
"id": 1,
"name": "New Event",
"description": "its awesome",
"start_date": "2019-02-07T12:00:00.000-05:00",
"end_date": "2019-02-08T12:00:00.000-05:00",
"all_day": null,
"status": "published",
"image_data": null,
"created_at": "2019-02-06T19:43:26.052-05:00",
"updated_at": "2019-02-06T19:43:26.052-05:00",
"recurring": {},
"recurring_until": null,
"seats": null,
"price_cents": null,
"public": true,
"currency": "USD"
}

patch
Update Event

https://yourcompany.sport-keeper.com/v1/events/:id
Update a single event. All of the above properties in create event are valid.
Request
Response
Headers
Authorization
optional
string
Auth token
200: OK
{
"id": 1,
"name": "New Event",
"description": "its awesome",
"start_date": "2019-02-07T12:00:00.000-05:00",
"end_date": "2019-02-08T12:00:00.000-05:00",
"all_day": null,
"status": "published",
"image_data": null,
"created_at": "2019-02-06T19:43:26.052-05:00",
"updated_at": "2019-02-06T19:43:26.052-05:00",
"recurring": {},
"recurring_until": null,
"seats": null,
"price_cents": null,
"public": true,
"currency": "USD"
}

delete
Delete a Event

https://yourcompany.sport-keeper.com/v1/events/:id
Delete an event.
Request
Response
Headers
Authorization
required
string
Auth token.
200: OK
‚Äč