Retrieve an event

GET/clubs/{connection_id}/event/{id}

Parameters

Returns

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this event
`created_at`	string (date-time)	No	The date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`group_id`	string	No	The group this event belongs to (reference to HrisGroup)
`name`	string	No	The event name (or a "Home vs Away" matchup label)
`description`	string	No	A description or notes for the event
`type`	enum	No	The event type Values: `GAME`, `PRACTICE`, `OTHER`
`status`	enum	No	The event status Values: `SCHEDULED`, `CANCELED`, `TBD`, `FINAL`
`start_at`	string (date-time)	No	When the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`end_at`	string (date-time)	No	When the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`timezone`	string	No	The timezone of the event
`duration_minutes`	number	No	The scheduled duration, in minutes
`location_id`	string	No	The id of the location for this event (reference to ClubsLocation)
`location_name`	string	No	The name of the location for this event
`opponent_id`	string	No	The id of the opposing team (single-opponent providers)
`opponent_name`	string	No	The name of the opposing team
`home_team_name`	string	No	The home team's name (homeaway providers)
`away_team_name`	string	No	The away team's name (homeaway providers)
`home_score`	number	No	The home team's score
`away_score`	number	No	The away team's score
`score_for`	number	No	The connected groupteam's score (team-vs-opponent providers)
`score_against`	number	No	The opponent's score (team-vs-opponent providers)
`is_home`	boolean	No	Whether the connected groupteam is the home side
`url`	string	No	A URL to the event

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'GET',
  url: 'https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.clubs.getClubsEvent({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/clubs/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?