Get schedule

GET

blitz-api

schedules

{scheduleId}

Get schedule detail

curl --request GET \
  --url https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "_id": "66f0a1b2c3d4e5f678901456",
  "eventType": "game",
  "eventTitle": "Falcons vs Guest Team",
  "startDate": "2026-10-01",
  "endDate": "2026-10-01",
  "teamOneId": "66f0a1b2c3d4e5f678901234",
  "teamTwoName": "Guest Team",
  "matchupFormat": "quarters",
  "teamOneScore": 27,
  "teamTwoScore": 20,
  "scoreBreakdown": {
    "format": "quarters",
    "teamOne": {
      "periods": [
        7,
        0,
        13,
        7
      ],
      "final": 27
    },
    "teamTwo": {
      "periods": [
        0,
        14,
        0,
        6
      ],
      "final": 20
    }
  },
  "createdAt": "2026-09-13T18:00:00.000Z"
}

{
  "error": 40101,
  "message": "Invalid API key",
  "timestamp": "2026-09-13T14:45:41.317Z",
  "traceId": "req_41f0e6c8a5ea232a"
}

{
  "error": 40101,
  "message": "Invalid API key",
  "timestamp": "2026-09-13T14:45:41.317Z",
  "traceId": "req_41f0e6c8a5ea232a"
}

{
  "error": 40101,
  "message": "Invalid API key",
  "timestamp": "2026-09-13T14:45:41.317Z",
  "traceId": "req_41f0e6c8a5ea232a"
}

Only scheduleId is required. The schedule must belong to a team in the API key organization. When teamTwoId is set on the schedule, the response looks up that team (same pattern as teamOneId) so you get an object with at least _id and name, not only a bare id string.

Scores

teamOneScore / teamTwoScore — final (or live running) game totals on the schedule.
matchupFormat — quarters, halves, or runningClock (default on create is often halves).
scoreBreakdown — period breakdown derived from scoring plays (points + clockStage), same layout as the Post Game Summary email:

`matchupFormat`	`scoreBreakdown.format`	`periods.length`
`quarters`	`quarters`	4 (Q1–Q4); overtime excluded from periods
`halves`	`halves`	2 (1H–2H); non-1st stages including OT go in period 2
`runningClock`	`runningClock`	0 (empty arrays; use `final` only)

scoreBreakdown.teamOne.final / scoreBreakdown.teamTwo.final always mirror teamOneScore / teamTwoScore. Period sums can be lower than final when OT (quarters) or plays lack clockStage — treat final as authoritative. Example (matchupFormat: "quarters"):

{
  "teamOneScore": 27,
  "teamTwoScore": 20,
  "matchupFormat": "quarters",
  "scoreBreakdown": {
    "format": "quarters",
    "teamOne": { "periods": [7, 0, 13, 7], "final": 27 },
    "teamTwo": { "periods": [0, 14, 0, 6], "final": 20 }
  }
}

The same scoreBreakdown object is also available under data.meta on Get schedule player statistics.

Authorizations

Authorization

string

header

required

Public integration API key (bb_live_...). Not a login JWT.

Path Parameters

scheduleId

string

required

Schedule document Mongo _id from create or list.

Example:

"507f1f77bcf86cd799439012"

Response

Schedule detail

teamOneScore

number

teamTwoScore

number

matchupFormat

enum<string>

Available options:

halves,

quarters,

runningClock

scoreBreakdown

object

Period breakdown by matchupFormat (same rules as Post Game Summary email). final mirrors teamOneScore/teamTwoScore.

Show child attributes

Get schedule detail

curl --request GET \
  --url https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.blitzboardstats.com/api/v1/blitz-api/schedules/{scheduleId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "_id": "66f0a1b2c3d4e5f678901456",
  "eventType": "game",
  "eventTitle": "Falcons vs Guest Team",
  "startDate": "2026-10-01",
  "endDate": "2026-10-01",
  "teamOneId": "66f0a1b2c3d4e5f678901234",
  "teamTwoName": "Guest Team",
  "matchupFormat": "quarters",
  "teamOneScore": 27,
  "teamTwoScore": 20,
  "scoreBreakdown": {
    "format": "quarters",
    "teamOne": {
      "periods": [
        7,
        0,
        13,
        7
      ],
      "final": 27
    },
    "teamTwo": {
      "periods": [
        0,
        14,
        0,
        6
      ],
      "final": 20
    }
  },
  "createdAt": "2026-09-13T18:00:00.000Z"
}

{
  "error": 40101,
  "message": "Invalid API key",
  "timestamp": "2026-09-13T14:45:41.317Z",
  "traceId": "req_41f0e6c8a5ea232a"
}

{
  "error": 40101,
  "message": "Invalid API key",
  "timestamp": "2026-09-13T14:45:41.317Z",
  "traceId": "req_41f0e6c8a5ea232a"
}

{
  "error": 40101,
  "message": "Invalid API key",
  "timestamp": "2026-09-13T14:45:41.317Z",
  "traceId": "req_41f0e6c8a5ea232a"
}

Get started

API reference

Scores

Authorizations

Path Parameters

Response

​Scores

Authorizations

Path Parameters

Response

Scores