clubs
event

Retrieve an event

get/clubs/{connection_id}/event/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/clubs/{connection_id}/event/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Event

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this event

created_atstring date-time

The date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

group_idstring

The group this event belongs to (reference to HrisGroup)

namestring

The event name (or a "Home vs Away" matchup label)

descriptionstring

A description or notes for the event

type'GAME' | 'PRACTICE' | 'OTHER'

The event type

status'SCHEDULED' | 'CANCELED' | 'TBD' | 'FINAL'

The event status

start_atstring date-time

When the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

When the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

timezonestring

The timezone of the event

duration_minutesnumber

The scheduled duration, in minutes

location_idstring

The id of the location for this event (reference to ClubsLocation)

location_namestring

The name of the location for this event

opponent_idstring

The id of the opposing team (single-opponent providers)

opponent_namestring

The name of the opposing team

home_team_namestring

The home team's name (homeaway providers)

away_team_namestring

The away team's name (homeaway providers)

home_scorenumber

The home team's score

away_scorenumber

The away team's score

score_fornumber

The connected groupteam's score (team-vs-opponent providers)

score_againstnumber

The opponent's score (team-vs-opponent providers)

is_homeboolean

Whether the connected groupteam is the home side

urlstring

A URL to the event

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.