clubs
event

List all events

Changed on

Returns a list of ClubsEvents. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/clubs/{connection_id}/event

Request

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

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

group_idstring

The group ID to filter by (reference to HrisGroup)

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

rawobject

The raw data returned by the integration for this event

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status