ScoreboardMax LogoScoreboardMax

API Documentation

ScoreboardMax API v1.0

Getting Started

Learn how to authenticate and make your first API request with ScoreboardMax.

Authentication

The ScoreboardMax API uses API tokens for authentication. Include your API token in the Authorization header of your requests. You can generate API keys with fine-grained access controls from within your account. Visit API Access from the left menu after you sign into your account.

Example Request

curl -H 'Authorization: Bearer your_api_token_here' \
  https://api.scoreboardmax.com/api/v1/scoreboards

Base URL

All API requests should be made to the base URL:

https://api.scoreboardmax.com/api/v1

TypeScript Support

For TypeScript developers, we provide official type definitions to enhance your development experience with full type safety and IntelliSense support.

Installation

npm install @scoreboardmax/api-types
View on NPM View on GitHub

Response Format

Unless otherwise noted, all responses are returned in JSON format. Successful responses will have appropriate HTTP status codes (200, 201, 204), while errors will return 4xx or 5xx status codes with error details.

Rate Limiting

API requests are rate limited to ensure fair usage. If you use the API with normal, typical use patterns, you will not encounter rate limits. However, if you exceed the limits, you will receive a 429 Too Many Requests response.

Error Handling

Understand how the ScoreboardMax API communicates errors and how to handle them in your application.

Error Response Format

When an error occurs, the API returns a JSON response with error details. All errors include a human-readable message, an error code for programmatic handling, and a unique reference ID for support purposes. See Error for more details on the response object.

Example Error Response

{
  "error": true,
  "code": "ResourceNotFound",
  "message": "The requested resource was not found: scoreboard: c3qxrt7caknrwr1",
  "statusCode": 404,
  "reference": "GY3KgCP"
}

Best Practices

Applications should rely on the HTTP response status code as the primary error signal, using the error code to provide additional precision for client messaging. Additional error codes may be added at any time, so your application should gracefully handle unknown error codes.

Tip: Use the reference ID when contacting support to help us quickly identify and resolve issues.

Error Codes by HTTP Status

400 Bad Request

InvalidColorFormat
InvalidDate
InvalidInput
InvalidRequest

401 Unauthorized

InvalidToken
InvalidSignIn
InvalidAccountSignIn

403 Forbidden

ForbiddenSelfPermissionsChange
InsufficientAdminPermissions
InsufficientItemPermissions
InsufficientResourcePermissions
InsufficientResourceItemPermissions
InvalidAuthType
InvalidPermissionGrant

404 Not Found

ResourceNotFound

409 Conflict

UserCredentialsInUse
AccountEmailInUse
AccountLimitExceeded
AccountStorageExceeded
ActiveScoreboardsExceeded
AccountFeatureNotEnabled
IncompatibleState
VersionConflict

429 Too Many Requests

RequestLimitExceeded

500 Internal Server Error

RemoteServerError
RemoteServerTimeout
UnspecifiedError
ImageProcessingError

API Reference

Scoreboard

Properties

object
string

Object type identifier

scoreboardId
string

Unique identifier for the scoreboard

url
string

Full URL to access this scoreboard resource

uri
string

URI path to access this scoreboard resource

name
stringnullable

Display name for the scoreboard

description
string

Auto-generated description based on team names and sport type

controlUrl
string

URL to the scoreboard control interface

embedUrl
string

URL to embed the scoreboard display with authentication token

type
string

The type of scoreboard. Possible values: "football", "basketball", "baseball", "soccer", "volleyball", "wrestling"

version
number

The current version number of this scoreboard. Include this value as 'version' in your next update request to prevent conflicts with other users.

data
BasketballData | FootballData | VolleyballData | SoccerData | BaseballData | WrestlingData

Sport-specific data structure that varies based on the type field

accountId
string

Account identifier that owns this scoreboard

accountLogoUrl
stringnullable

URL to the account logo image

accountLogoPreviewUrl
stringnullable

URL to the account logo preview image

dateCreated
string

ISO timestamp when the scoreboard was created

dateModified
string

ISO timestamp when the scoreboard was last modified

currentServerTimestamp
number

Current server timestamp for synchronization purposes

clocks
string | ClockListexpandable

URL to the clocks associated with this scoreboard

overlay
string | Overlayexpandable

URL to the overlay associated with this scoreboard

Response Example

{
  "object": "scoreboard",
  "scoreboardId": "njv9e5218292fb",
  "url": "https://api.scoreboardmax.com/api/v1/scoreboards/njv9e5218292fb",
  "uri": "/scoreboards/njv9e5218292fb",
  "type": "football",
  "name": "Varsity Football",
  "description": "Football - Cedar Hill vs Westbrook",
  "controlUrl": "https://app.scoreboardmax.com/scoreboard/njv9e5218292fb/control",
  "embedUrl": "https://app.scoreboardmax.com/scoreboard/njv9e5218292fb/embed?token=q9qKf9dnap9vB1GNuX2AQkr4A2m9BmOb",
  "version": 19,
  "data": {
    "distanceToGo": null,
    "down": null,
    "flag": false,
    "period": "1",
    "settings": {
      "clockAscending": false,
      "clockStopsOnFirstDown": true,
      "downAndDistanceDisplay": "both",
      "enableClockAutomations": true,
      "enableKeyboardShortcuts": true,
      "enableMercyRule": false,
      "halfLength": 900,
      "hideFlagAfter": 25,
      "periodLength": 720,
      "playClockLength": 40,
      "playClockSecondaryLength": 25,
      "showAccountLogo": true,
      "showGameClock": true,
      "showPlayClock": false,
      "showPlayClockWhenLow": false,
      "showPossession": true,
      "showSponsors": true,
      "showTimeouts": true,
      "sponsorFilter": null,
      "timeoutsPerHalf": 3
    },
    "team1": {
      "abbreviation": "CH",
      "color": "#7BAFD4",
      "description": null,
      "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
      "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
      "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
      "name": "Cedar Hill",
      "possession": false,
      "reference": "if4d91oa4ma",
      "roster": null,
      "rosterId": null,
      "score": 0,
      "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
      "teamId": "6jm32ffm1",
      "timeoutsLeft": 3
    },
    "team2": {
      "abbreviation": "WES",
      "color": "#b9271d",
      "description": null,
      "logoFilename": "9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
      "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e_p.avif",
      "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
      "name": "Westbrook",
      "possession": false,
      "reference": "ofnot0ab2ln",
      "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
      "rosterId": "jyxdhd9cx",
      "score": 0,
      "team": "https://api.scoreboardmax.com/api/v1/teams/8tm5fzpnc",
      "teamId": "8tm5fzpnc",
      "timeoutsLeft": 3
    },
    "type": "football"
  },
  "accountLogoUrl": null,
  "accountLogoPreviewUrl": null,
  "overlay": "https://api.scoreboardmax.com/api/v1/scoreboards/njv9e5218292fb/overlay",
  "clocks": "https://api.scoreboardmax.com/api/v1/scoreboards/njv9e5218292fb/clocks",
  "accountId": "M30540120",
  "dateCreated": "2025-08-02T14:04:25.034Z",
  "dateModified": "2025-08-02T14:04:25.034Z",
  "currentServerTimestamp": 1754143465
}

Create a scoreboard

Creates a new scoreboard with the specified sport type and configuration. The scoreboard will be initialized with default values and can be customized through the data object.

POST201/api/v1/scoreboards
Returns:Scoreboard
Request Body

Get a scoreboard

Retrieves a specific scoreboard by its unique identifier. Returns the complete scoreboard configuration including current game state.

GET200/api/v1/scoreboards/{scoreboardId}
Returns:Scoreboard
Path Parameters
scoreboardId
string

Unique identifier for the scoreboard

Get a list of scoreboards

Retrieves a paginated list of scoreboards for the authenticated account. Results are ordered by creation date in descending order by default.

GET200/api/v1/scoreboards
Returns:ScoreboardList
Query Parameters
limit
numberoptional

Maximum number of scoreboards to return (default: 25, max: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of scoreboards.

desc
booleanoptional

Sort results in descending order by creation date (default: true)

Update a scoreboard

Updates an existing scoreboard with new configuration data. All fields in the request will replace the current values.

PUT200/api/v1/scoreboards/{scoreboardId}
Returns:Scoreboard
Path Parameters
scoreboardId
string

Unique identifier for the scoreboard

Request Body

Reset scoreboard settings

Resets the scoreboard settings to default values while preserving game data such as scores and game state.

POST200/api/v1/scoreboards/{scoreboardId}/reset/settings
Returns:Scoreboard
Path Parameters
scoreboardId
string

Unique identifier for the scoreboard

Request Body
None

Reset scoreboard data

Resets the scoreboard game data such as scores, time, and game state while preserving settings configuration. This configures the scoreboard for a new game.

POST200/api/v1/scoreboards/{scoreboardId}/reset/data
Returns:Scoreboard
Path Parameters
scoreboardId
string

Unique identifier for the scoreboard

Request Body
None

Activate a scoreboard

This will force a scoreboard to be activated for live use by deactivating and resetting the scoreboard that's been inactive the longest. This is used when you want to start using a scoreboard and the account has reached its maximum number of concurrently active scoreboards.

POST204/api/v1/scoreboards/{scoreboardId}/activate
Returns:None
Path Parameters
scoreboardId
string

Unique identifier for the scoreboard

Request Body
None

Delete a scoreboard

Permanently deletes a scoreboard and all associated data. This action cannot be undone.

DELETE204/api/v1/scoreboards/{scoreboardId}
Returns:None
Path Parameters
scoreboardId
string

Unique identifier for the scoreboard

Refresh scoreboard

This forces a browser refresh on all connected scoreboard clients. This will cause a momentary disruption to the display but is useful in cases where the scoreboard display may be experiencing issues or needs to be synchronized. Note that if a client is in a severe error state it may not respond to the request and may need to be manually refreshed.

POST204/api/v1/scoreboards/{scoreboardId}/refresh
Returns:None
Path Parameters
scoreboardId
string

Unique identifier for the scoreboard

Request Body
None

Subscribe to websocket updates

Subscribe to real-time updates for the scoreboard via websocket connection

POST200/api/v1/scoreboards/{scoreboardId}/websocket-subscribe
Returns:WebsocketSubscription
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

Unsubscribe from websocket updates

Unsubscribe from real-time updates for the scoreboard websocket connection

POST204/api/v1/scoreboards/{scoreboardId}/websocket-unsubscribe
Returns:None
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

Clock

Properties

object
string

The object type identifier, always 'clock'.

url
string

The full URL to access this clock resource.

uri
string

The relative URI path to access this clock resource.

clockId
string

The identifier for this clock. This will always be the type of clock for the scoreboard, such as 'game', 'shot', 'play', etc., depending on the sport.

scoreboardId
string

The unique identifier of the scoreboard this clock belongs to.

accountId
string

The unique identifier of the account that owns this clock.

seconds
numbernullable

The current clock time in seconds. If null, the clock is disabled (not displayed on the scoreboard) which is different from a clock with 0 seconds.

running
boolean

Whether the clock is currently running (true) or stopped (false).

ascending
boolean

Controls the clock direction. Set to true to count up (from 0), or false to count down (towards 0).

asOfTimestamp
number

The Unix timestamp (in milliseconds) when the clock state was last updated. This is a precise time that is closely synchronized with atomic time servers.

stopAt
numberoptional

Optional time in seconds when the clock should automatically stop; if not set, descending clocks stop at 0 and ascending clocks run indefinitely.

display
stringnullable

The formatted clock time (e.g., '8:32') at the moment the response was generated; provided for debugging and client configuration purposes only—it should not be used for display, as clients must calculate the correct display time based on the clock's last update time, current time, and running status.

nowTimestamp
number

The current server Unix timestamp (in milliseconds) when this response was generated. This is a precise time that is closely synchronized with atomic time servers.

Response Example

{
  "object": "clock",
  "url": "https://api.scoreboardmax.com/api/v1/scoreboards/3mtxuvrbq957bb/clocks/game",
  "accountId": "M30540120",
  "asOfTimestamp": 1754270920766,
  "ascending": false,
  "clockId": "game",
  "display": "8:00",
  "nowTimestamp": 1754270920932,
  "running": true,
  "scoreboardId": "3mtxuvrbq957bb",
  "seconds": 480,
  "uri": "/scoreboards/3mtxuvrbq957bb/clocks/game"
}

Get a list of clocks

Retrieves all clocks associated with a specific scoreboard.

GET200/api/v1/scoreboards/{scoreboardId}/clocks
Returns:ClockList
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

Get a clock

Retrieves a specific clock by its ID within a scoreboard.

GET200/api/v1/scoreboards/{scoreboardId}/clocks/{clockId}
Returns:Clock
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

clockId
string

The unique identifier of the clock

Update a clock

Updates the state of a specific clock, including its time, running status, and direction.

PUT200/api/v1/scoreboards/{scoreboardId}/clocks/{clockId}
Returns:Clock
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

clockId
string

The unique identifier of the clock

Request Body

Overlay

Properties

type
string

The type of overlay content. Possible values: "players", "sponsors"

data
array of PlayerSummary | array of SponsorSummary

Array of overlay data items. The structure varies based on the type field - either PlayerSummary objects for player overlays or SponsorSummary objects for sponsor overlays

title
stringoptionalnullable

Optional title to display with the overlay content

color
stringoptional

Optional color for the overlay display in hex format (e.g., #b9271d)

Response Example

{
  "type": "players",
  "color": "#b9271d",
  "data": [
    {
      "playerId": "GYLGopjU",
      "firstName": "Darnell",
      "lastName": "Brooks",
      "number": "25",
      "position": "Linebacker",
      "imageFilename": "e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f.avif",
      "imageUrl": "https://api.scoreboardmax.com/m30540120/playerPhoto/e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f.avif",
      "imagePreviewUrl": "https://api.scoreboardmax.com/m30540120/playerPhoto/e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f_p.avif",
      "imageMediumUrl": "https://api.scoreboardmax.com/m30540120/playerPhoto/e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f_m.avif"
    }
  ]
}

Get overlay

Retrieves the current overlay content for a scoreboard

GET200/api/v1/scoreboards/{scoreboardId}/overlay
Returns:Overlay
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

Set overlay

Sets or updates the overlay content for a scoreboard

POST200/api/v1/scoreboards/{scoreboardId}/overlay
Returns:Overlay
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

Request Body

Delete overlay

Removes the overlay content from a scoreboard

DELETE204/api/v1/scoreboards/{scoreboardId}/overlay
Returns:None
Path Parameters
scoreboardId
string

The unique identifier of the scoreboard

Preset

Properties

object
string

String representing the object's type. Always 'preset' for this object

presetId
string

Unique identifier for the preset

url
string

The full URL to access this preset

uri
string

The relative URI to access this preset

name
string

The name of the preset

description
stringnullable

A description of the preset, for your reference

type
string

The type of scoreboard this preset applies to. Possible values: "football", "basketball", "baseball", "soccer", "volleyball", "wrestling"

data
BaseballSettings | BasketballSettings | FootballSettings | SoccerSettings | VolleyballSettings | WrestlingSettings

Sport-specific settings data structure that varies based on the type field

dateCreated
string

ISO 8601 timestamp when the preset was created

dateModified
string

ISO 8601 timestamp when the preset was last modified

Response Example

{
  "object": "preset",
  "presetId": "r4qvbm3tybpffb",
  "url": "https://api.scoreboardmax.com/api/v1/presets/r4qvbm3tybpffb",
  "uri": "/presets/r4qvbm3tybpffb",
  "type": "football",
  "name": "Default Football Preset",
  "description": "Default football settings. You can modify or delete this preset.",
  "data": {
    "clockAscending": false,
    "clockStopsOnFirstDown": true,
    "downAndDistanceDisplay": "both",
    "enableClockAutomations": true,
    "enableKeyboardShortcuts": true,
    "enableMercyRule": false,
    "halfLength": 900,
    "hideFlagAfter": 25,
    "periodLength": 720,
    "playClockLength": 40,
    "playClockSecondaryLength": 25,
    "showAccountLogo": true,
    "showGameClock": true,
    "showPlayClock": true,
    "showPlayClockWhenLow": false,
    "showPossession": true,
    "showSponsors": true,
    "showTimeouts": true,
    "sponsorFilter": [],
    "timeoutsPerHalf": 3
  },
  "dateCreated": "2025-06-04T15:07:41.127Z",
  "dateModified": "2025-08-04T17:08:59.018Z"
}

Create a preset

Creates a new preset with the specified sport-specific settings configuration

POST201/api/v1/presets
Returns:Preset
Request Body

Get a preset

Retrieves details of a specific preset

GET200/api/v1/presets/{presetId}
Returns:Preset
Path Parameters
presetId
string

The unique identifier of the preset

Get a list of presets

Retrieves a paginated list of presets for the account

GET200/api/v1/presets
Returns:PresetList
Query Parameters
type
stringoptional

Filter presets by scoreboard type. Possible values: "football", "basketball", "baseball", "soccer", "volleyball", "wrestling"

limit
numberoptional

Maximum number of presets to return (default and maximum: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of presets.

Update a preset

Updates an existing preset with new settings configuration

PUT200/api/v1/presets/{presetId}
Returns:Preset
Path Parameters
presetId
string

The unique identifier of the preset

Request Body

Delete a preset

Deletes a preset permanently

DELETE204/api/v1/presets/{presetId}
Returns:None
Path Parameters
presetId
string

The unique identifier of the preset

Team

Properties

object
string

The object type, always 'team'

teamId
string

The unique identifier for the team

url
string

The full URL to access this team resource

uri
string

The URI path to access this team resource

name
string

The name of the team

description
stringnullable

An optional description of the team, for your reference. Not displayed on the scoreboard.

color
string

The team's primary color in hexadecimal format

logoFilename
stringnullable

The filename of the team's logo image

logoUrl
stringnullable

The full URL to the team's logo image

logoPreviewUrl
stringnullable

The full URL to the team's logo preview image

rosterId
stringnullable

The ID of the roster associated with this team

roster
string | Rosterexpandablenullable

The roster associated with this team. By default returns a URL string, but can be expanded to include the full roster object

accountId
string

The account ID that owns this team

dateCreated
string

The ISO 8601 timestamp when the team was created

dateModified
string

The ISO 8601 timestamp when the team was last modified

Response Example

{
  "object": "team",
  "teamId": "6jm32ffm1",
  "url": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
  "uri": "/teams/6jm32ffm1",
  "name": "Cedar Hill",
  "description": null,
  "color": "#7BAFD4",
  "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
  "rosterId": null,
  "roster": null,
  "accountId": "M30540120",
  "dateCreated": "2025-07-30T21:19:40.255Z",
  "dateModified": "2025-08-04T18:14:35.555Z"
}

Create a team

Creates a new team with the specified properties

POST201/api/v1/teams
Returns:Team
Request Body

Get a team

Retrieves a specific team by its ID

GET200/api/v1/teams/{teamId}
Returns:Team
Path Parameters
teamId
string

The unique identifier of the team to retrieve

Get a list of teams

Retrieves a paginated list of teams for the authenticated account

GET200/api/v1/teams
Returns:TeamList
Query Parameters
limit
numberoptional

Maximum number of teams to return (default and maximum: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of teams.

Update a team

Updates an existing team with the specified properties

PUT200/api/v1/teams/{teamId}
Returns:Team
Path Parameters
teamId
string

The unique identifier of the team to update

Request Body

Delete a team

Permanently deletes a team. This action cannot be undone.

DELETE204/api/v1/teams/{teamId}
Returns:None
Path Parameters
teamId
string

The unique identifier of the team to delete

Roster

Properties

object
string

The object type, always 'roster'

rosterId
string

Unique identifier for the roster

url
string

Full URL to access this roster

uri
string

URI path to access this roster

name
string

The name of the roster

type
string

The type of scoreboard this roster is designed for. Possible values: "baseball", "basketball", "football", "soccer", "volleyball", "wrestling"

attributes
array of string

Custom attribute names that can be used to track additional information for players on this roster

groups
array of string

Group names that can be used to organize players on this roster into categories (e.g. 'Captains', 'Starters', etc.)

players
string | PlayerListexpandable

URL to access the players in this roster, or the expanded player data if requested

playerCount
number

The total number of players in this roster

accountId
string

The account ID that owns this roster

dateCreated
string

ISO 8601 timestamp when the roster was created

dateModified
string

ISO 8601 timestamp when the roster was last modified

Response Example

{
  "object": "roster",
  "rosterId": "jyxdhd9cx",
  "url": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
  "uri": "/rosters/jyxdhd9cx",
  "name": "Fairview Football",
  "type": "football",
  "attributes": [],
  "groups": [
    "Captains",
    "Defense Starters",
    "Offense Starters"
  ],
  "players": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx/players",
  "playerCount": 7,
  "accountId": "M30540120",
  "dateCreated": "2025-07-30T21:23:30.691Z",
  "dateModified": "2025-08-04T17:15:57.000Z"
}

Create a roster

Creates a new roster with the specified name, type, and optional players

POST201/api/v1/rosters
Returns:Roster
Request Body

Get a roster

Retrieves a specific roster by ID. Supports multiple response formats including JSON, CSV, PDF, and Excel. Use the 'Accept' header to specify the desired format: 'application/json', 'text/csv', 'application/pdf', or 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'

GET200/api/v1/rosters/{rosterId}
Returns:Roster
Path Parameters
rosterId
string

The unique identifier of the roster

Get a list of rosters

Retrieves a paginated list of rosters for the account

GET200/api/v1/rosters
Returns:RosterList
Query Parameters
limit
numberoptional

Maximum number of rosters to return (default and maximum: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of rosters.

Update a roster

Updates an existing roster with new information

PUT200/api/v1/rosters/{rosterId}
Returns:Roster
Path Parameters
rosterId
string

The unique identifier of the roster

Request Body

Delete a roster

Deletes a roster permanently

DELETE204/api/v1/rosters/{rosterId}
Returns:None
Path Parameters
rosterId
string

The unique identifier of the roster

Player

Properties

object
string

The object type, always 'player'

url
string

The full URL to this player resource

uri
string

The URI path to this player resource

playerId
string

Unique identifier for the player

rosterId
string

The ID of the roster this player belongs to

firstName
string

The player's first name

lastName
string

The player's last name

number
stringnullable

The player's jersey number

position
stringnullable

The player's position on the team

imageFilename
stringnullable

The filename of the player's photo

imageUrl
stringnullable

The full URL to the player's photo. Can be null if no photo is provided.

imagePreviewUrl
stringnullable

The URL to a preview-sized version of the player's photo. Can be null if no photo is provided.

imageMediumUrl
stringnullable

The URL to a medium-sized version of the player's photo. Can be null if no photo is provided.

attributes
object

Custom attributes for the player as key-value pairs

groups
array of string

Groups or categories the player belongs to

accountId
string

The account ID that owns this player

dateCreated
string

ISO 8601 timestamp when the player was created

dateModified
string

ISO 8601 timestamp when the player was last modified

Response Example

{
  "object": "player",
  "playerId": "tUwA4QQc",
  "url": "https://api.scoreboardmax.com/api/v1/rosters/kd4abk3s7/players/tUwA4QQc",
  "uri": "/rosters/kd4abk3s7/players/tUwA4QQc",
  "firstName": "Jalen",
  "lastName": "Brooks",
  "number": "24",
  "position": "Wide Receiver",
  "imageFilename": null,
  "imageUrl": null,
  "imagePreviewUrl": null,
  "imageMediumUrl": null,
  "attributes": {
    "Weight": "180"
  },
  "groups": [
    "Captains",
    "Starters"
  ],
  "rosterId": "kd4abk3s7",
  "accountId": "M30540120",
  "dateCreated": "2025-08-04T16:51:28.276Z",
  "dateModified": "2025-08-04T16:51:28.276Z"
}

Create a Player

Creates a new player within a roster

POST201/api/v1/rosters/{rosterId}/players
Returns:Player
Path Parameters
rosterId
string

The unique identifier of the roster to add the player to

Request Body

Get a Player

Retrieves a specific player by ID

GET200/api/v1/rosters/{rosterId}/players/{playerId}
Returns:Player
Path Parameters
rosterId
string

The unique identifier of the roster

playerId
string

The unique identifier of the player

Get a list of Players

Retrieves a list of players within a roster

GET200/api/v1/rosters/{rosterId}/players
Returns:PlayerList
Path Parameters
rosterId
string

The unique identifier of the roster

Query Parameters
limit
numberoptional

Maximum number of players to return (default: 100, max: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of players.

desc
booleanoptional

Sort results in descending order

search
stringoptional

Search term to filter players. You can search by "firstName", "lastName", "number", "position". Partial searches are supported.

Update a Player

Updates an existing player

PUT200/api/v1/rosters/{rosterId}/players/{playerId}
Returns:Player
Path Parameters
rosterId
string

The unique identifier of the roster

playerId
string

The unique identifier of the player to update

Request Body

Delete a Player

Deletes a player from the roster

DELETE204/api/v1/rosters/{rosterId}/players/{playerId}
Returns:None
Path Parameters
rosterId
string

The unique identifier of the roster

playerId
string

The unique identifier of the player to delete

PlayerSummary

Properties

playerId
stringnullable

The unique identifier of the player. Can be null for players that are not saved to a roster.

firstName
stringnullable

The first name of the player. Can be null if not provided.

lastName
stringnullable

The last name of the player. Can be null if not provided.

number
stringnullable

The jersey number of the player. Can be null if not assigned.

position
stringnullable

The position of the player. Can be null if not specified.

imageFilename
stringnullable

The filename of the player's photo. Can be null if no photo is provided.

imageUrl
stringnullable

The full-size URL of the player's photo. Can be null if no photo is provided.

imagePreviewUrl
stringnullable

The preview-size URL of the player's photo. Can be null if no photo is provided.

imageMediumUrl
stringnullable

The medium-size URL of the player's photo. Can be null if no photo is provided.

Response Example

{
  "playerId": "GYLGopjU",
  "firstName": "Darnell",
  "lastName": "Brooks",
  "number": "25",
  "position": "Linebacker",
  "imageFilename": "e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f.avif",
  "imageUrl": "https://api.scoreboardmax.com/m30540120/playerPhoto/e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f.avif",
  "imagePreviewUrl": "https://api.scoreboardmax.com/m30540120/playerPhoto/e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f_p.avif",
  "imageMediumUrl": "https://api.scoreboardmax.com/m30540120/playerPhoto/e20ff9d2-de89-47c1-bd11-8d5e3e1cde7f_m.avif"
}

Sponsor

Properties

object
string

Object type identifier, always 'sponsor'

url
string

Full URL to this sponsor resource

uri
string

URI path to this sponsor resource

sponsorId
string

Unique identifier for the sponsor

name
string

The name of the sponsor

website
stringoptional

The sponsor's website URL

active
boolean

Whether the sponsor is active and should be displayed

groups
array of string

Array of group names that this sponsor belongs to

logoFilename
string

The filename of the uploaded logo image for the sponsor

logoUrl
string

Full URL to the sponsor's logo image

logoPreviewUrl
string

Full URL to the sponsor's logo preview image (smaller version)

logoMediumUrl
string

Full URL to the sponsor's logo medium-sized image

accountId
string

The account ID that owns this sponsor

dateCreated
string

ISO 8601 timestamp when the sponsor was created

dateModified
string

ISO 8601 timestamp when the sponsor was last modified

Response Example

{
  "object": "sponsor",
  "sponsorId": "scwz1hd5",
  "url": "https://api.scoreboardmax.com/api/v1/sponsors/scwz1hd5",
  "uri": "/sponsors/scwz1hd5",
  "name": "Midstate Bank & Trust",
  "logoFilename": "3eeb65ce-1315-46df-9ea0-2d7e9d28ff2a.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/sponsorLogo/3eeb65ce-1315-46df-9ea0-2d7e9d28ff2a.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/sponsorLogo/3eeb65ce-1315-46df-9ea0-2d7e9d28ff2a_p.avif",
  "logoMediumUrl": "https://cdn.scoreboardmax.com/m30540120/sponsorLogo/3eeb65ce-1315-46df-9ea0-2d7e9d28ff2a_m.avif",
  "groups": [
    "Silver"
  ],
  "accountId": "M30540120",
  "dateCreated": "2025-08-04T17:58:55.234Z",
  "dateModified": "2025-08-04T17:58:55.234Z"
}

Create a sponsor

Creates a new sponsor with the provided details

POST201/api/v1/sponsors
Returns:Sponsor
Request Body

Get a sponsor

Retrieves a specific sponsor by its ID

GET200/api/v1/sponsors/{sponsorId}
Returns:Sponsor
Path Parameters
sponsorId
string

The unique identifier of the sponsor

Get a list of sponsors

Retrieves a paginated list of sponsors for the account

GET200/api/v1/sponsors
Returns:SponsorList
Query Parameters
limit
numberoptional

Maximum number of sponsors to return (default and maximum: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of sponsors.

desc
booleanoptional

Sort sponsors in descending order

search
stringoptional

Search term to filter sponsors by name

active
booleanoptional

Filter sponsors by active status

Update a sponsor

Updates an existing sponsor with the provided details

PUT200/api/v1/sponsors/{sponsorId}
Returns:Sponsor
Path Parameters
sponsorId
string

The unique identifier of the sponsor

Request Body

Delete a sponsor

Deletes a sponsor from the account

DELETE204/api/v1/sponsors/{sponsorId}
Returns:None
Path Parameters
sponsorId
string

The unique identifier of the sponsor

Get sponsor groups

Retrieves all available sponsor groups for the account

GET200/api/v1/sponsors/groups
Returns:string[]

Set sponsor groups

Updates the list of available sponsor groups for the account

PUT200/api/v1/sponsors/groups
Returns:string[]
Request Body
string[]

Clear sponsor group

Removes all sponsors from a specific group

POST200/api/v1/sponsors/groups/clear
Returns:string[]
Query Parameters
group
string

The name of the group to clear

Request Body
None

SponsorSummary

Properties

sponsorId
stringnullable

The unique identifier for the sponsor. Can be null for sponsors that are not saved.

name
stringnullable

The name of the sponsor

website
stringnullable

The website URL for the sponsor

imageFilename
stringnullable

The filename of the sponsor's logo image

imageUrl
stringnullable

The full URL to the sponsor's logo image. Can be null if no image is provided.

imagePreviewUrl
stringnullable

The URL to a preview version of the sponsor's logo image. Can be null if no image is provided.

imageMediumUrl
stringnullable

The URL to a medium-sized version of the sponsor's logo image. Can be null if no image is provided.

Response Example

{
  "sponsorId": "ez5gtz72",
  "name": "Summit Valley Dental",
  "website": null,
  "imageFilename": "9974f87e-741d-4cd6-aca5-6619adde3b22.avif",
  "imageUrl": "https://api.scoreboardmax.com/m30540120/sponsorLogo/9974f87e-741d-4cd6-aca5-6619adde3b22.avif",
  "imagePreviewUrl": "https://api.scoreboardmax.com/m30540120/sponsorLogo/9974f87e-741d-4cd6-aca5-6619adde3b22_p.avif",
  "imageMediumUrl": "https://api.scoreboardmax.com/m30540120/sponsorLogo/9974f87e-741d-4cd6-aca5-6619adde3b22_m.avif"
}

File

Properties

object
string

Object type identifier, always 'file'

fileId
string

Unique identifier for the file

url
string

Full API URL for accessing this file resource

uri
string

Relative URI path for this file resource

filename
string

The filename of the uploaded file

fileUrl
string

Direct URL to access the file content from the CDN

accountId
string

Identifier of the account that owns this file

type
string

The type of file. Possible values: "teamLogo", "accountLogo", "playerPhoto", "sponsorLogo", "temporary"

size
number

File size in bytes. Note that for some images, we create several optimized versions of the image (for previews, thumbnails, etc.), so the size may differ from the original upload.

dateCreated
string

ISO 8601 timestamp when the file was created

Response Example

{
  "object": "file",
  "fileId": "0772b7d1-465c-41fa-8f91-e061c5439a2e",
  "url": "https://api.scoreboardmax.com/api/v1/files/0772b7d1-465c-41fa-8f91-e061c5439a2e",
  "uri": "/files/0772b7d1-465c-41fa-8f91-e061c5439a2e",
  "fileUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/0772b7d1-465c-41fa-8f91-e061c5439a2e.avif",
  "filename": "0772b7d1-465c-41fa-8f91-e061c5439a2e.avif",
  "type": "teamLogo",
  "size": 389625,
  "accountId": "M30540120",
  "dateCreated": "2025-08-04T01:49:35.347Z"
}

Create a file

Creates a new file from a completed upload session. The upload session must be completed before calling this endpoint.

POST201/api/v1/files
Returns:File
Request Body

Get a file

Retrieves details about a specific file including its metadata and CDN URL.

GET200/api/v1/files/{fileId}
Returns:File
Path Parameters
fileId
string

The unique identifier of the file

Get a list of files

Retrieves a paginated list of files for the authenticated account.

GET200/api/v1/files
Returns:FileList
Query Parameters
type
stringoptional

Filter files by type. Possible values: "teamLogo", "accountLogo", "playerPhoto", "sponsorLogo", "temporary"

limit
numberoptional

Maximum number of files to return (default and maximum: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of files.

Delete a file

Permanently deletes a file and removes it from the CDN. This action cannot be undone.

DELETE204/api/v1/files/{fileId}
Returns:None
Path Parameters
fileId
string

The unique identifier of the file to delete

Extract data from file

Extracts tabular data from supported file formats (CSV, Excel) for processing and import operations.

POST200/api/v1/files/{fileId}/extract
Returns:DataExtract
Path Parameters
fileId
string

The unique identifier of the file to extract data from

Query Parameters
hasHeaderRow
booleanoptional

Whether the first row contains column headers (default: false)

Request Body
None

UploadSession

Properties

object
string

Object type identifier, always "uploadSession"

uploadId
string

Unique identifier for the upload session

uploadUrl
string

Pre-signed URL for uploading the file to cloud storage

type
string

The type of file being uploaded. Possible values: "teamLogo", "accountLogo", "playerPhoto", "sponsorLogo", "temporary"

filename
string

The generated filename that will be used for storage

reference
stringoptional

Reference identifier for the upload session, if provided in the request.

contentType
string

MIME type of the file being uploaded. For images, the following formats are supported: 'png', 'jpg', 'gif', 'webp', and 'avif'.

dateCreated
string

ISO 8601 timestamp when the upload session was created

Response Example

{
  "object": "uploadSession",
  "uploadId": "yzGyEI9IUCySs8MPZ5YdS6nLeMpoEj4ZNrPY61byflUj98duH+fzwBx0BpF98+avRMKqc3/ABgFCwzrtE9wK6uo+JAKbhpT5g4MLNB/0W6iyVBKHWZnL6eMX",
  "uploadUrl": "https://scoreboardmax-upload.s3.us-west-2.amazonaws.com/uploads/m30540120/63ca00c6-6670-4486-9c0a-761a4c28c8b5.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4JKMYRPGLFJFQ76N%2F20250804%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20250804T182410Z&X-Amz-Expires=900&X-Amz-Signature=7c4a184cb9e84f6f4d4533d95c5c040c567ded0f3f16997ee87766ff4e7f3b49&X-Amz-SignedHeaders=host&x-amz-meta-x-amz-meta-max-file-size=20971520&x-id=PutObject",
  "type": "playerPhoto",
  "filename": "63ca00c6-6670-4486-9c0a-761a4c28c8b5.png",
  "reference": "JS6ZuWlJ",
  "contentType": "image/png",
  "dateCreated": "2025-08-04T18:24:10.639Z"
}

Create an upload session

Creates a new upload session with a pre-signed URL for file upload. The upload session provides a secure, temporary URL that can be used to upload files directly to cloud storage. The uploaded file can then be used to create a File.

POST201/api/v1/uploadSessions
Returns:UploadSession

User

Properties

object
string

The type of object, always 'user'

userId
string

Unique identifier for the user

url
string

Full URL to access this user resource

uri
string

URI path to access this user resource

name
stringoptional

The full name of the user

email
string

The email address of the user

pending
boolean

Whether the user invitation is pending acceptance

accountId
string

The account ID this user belongs to

account
string | Accountexpandable

Reference to the account this user belongs to

permissions
Permissions

Permission settings defining what actions the user can perform on various resources

dateCreated
string

ISO 8601 timestamp when the user was created

dateModified
string

ISO 8601 timestamp when the user was last modified

dateLastActivity
stringnullable

ISO 8601 timestamp of the user's last activity

Response Example

{
  "object": "user",
  "userId": "QSKKsuAFG",
  "url": "https://api.scoreboardmax.com/api/v1/users/QSKKsuAFG",
  "uri": "/users/QSKKsuAFG",
  "name": "Jessica Rivens",
  "email": "jessica.rivens@example.com",
  "pending": true,
  "accountId": "M30540120",
  "account": "https://api.scoreboardmax.com/api/v1/accounts/m30540120",
  "permissions": {
    "allow": {
      "*": [
        {
          "*": [
            "*"
          ]
        }
      ]
    },
    "deny": {
      "user": [
        {
          "*": [
            "*"
          ]
        }
      ]
    }
  },
  "dateCreated": "2025-08-04T18:40:53.147Z",
  "dateModified": "2025-08-04T18:40:53.147Z",
  "dateLastActivity": null
}

Get a user

Retrieves a specific user by their unique identifier

GET200/api/v1/users/{userId}
Returns:User
Path Parameters
userId
string

The unique identifier of the user

Get a list of users

Retrieves a paginated list of users for the account

GET200/api/v1/users
Returns:UserList
Query Parameters
limit
numberoptional

Maximum number of users to return (default and maximum: 100)

after
stringoptional

The after value is a pagination cursor. Use the value from the pageNext URL in the previous response to fetch the next page of users.

Create a user

Creates a new user and sends an invitation email

POST201/api/v1/users
Returns:User
Request Body

Update a user

Updates an existing user's information and permissions

PUT200/api/v1/users/{userId}
Returns:User
Path Parameters
userId
string

The unique identifier of the user

Request Body

Delete a user

Removes a user from the account

DELETE204/api/v1/users/{userId}
Returns:None
Path Parameters
userId
string

The unique identifier of the user

Send user invitation

Resends an invitation email to a pending user

POST200/api/v1/users/{userId}/invite
Returns:None
Path Parameters
userId
string

The unique identifier of the user

Request Body
None

ServerTime

Properties

now
string

The current server time in ISO 8601 format (UTC)

nowTimestamp
number

The current server time as a Unix timestamp in milliseconds

Response Example

{
  "now": "2025-08-04T17:45:32.703Z",
  "nowTimestamp": 1754329532703
}

Get server time

Retrieves the current server time in both ISO 8601 format and Unix timestamp format. This endpoint can be used to synchronize client time with server time.

GET200/api/v1/server-time
Returns:ServerTime

DataExtract

Properties

fileId
string

The unique identifier of the file that was processed

data
array of array of string

The extracted data as a two-dimensional array where each inner array represents a row and each string represents a cell value

removeDuplicates
boolean

Whether duplicate rows were removed from the extracted data

Response Example

{
  "fileId": "866dd2e8-6e40-456d-a4c3-f7c5cc4519ba",
  "data": [
    [
      "First Name",
      "Last Name", 
      "Jersey Number",
      "Position",
      "Grade",
      "Height"
    ],
    [
      "Emily",
      "Nguyen",
      "7", 
      "Forward",
      "11",
      "5'4"
    ],
    [
      "Jasmine",
      "Lopez",
      "12",
      "Midfielder", 
      "10",
      "5'6"
    ],
  ],
  "removeDuplicates": true
}

WebsocketSubscription

Properties

connectionId
string

The unique connection identifier for the websocket connection

subscriptionResource
string

The type of resource being subscribed to

subscriptionResourceUri
string

The URI of the resource being subscribed to

accountId
string

The account identifier associated with the subscription

Response Example

{
  "connectionId": "O8kcufrpPHcCJMA=",
  "resourceUri": "/scoreboards/m5ezyvgavd2pfb",
  "subscriptionResource": "scoreboard",
  "subscriptionResourceUri": "/scoreboards/m5ezyvgavd2pfb",
  "accountId": "m30540120"
}

Event

Properties

object
string

The object type identifier. Always set to 'event'.

eventId
string

The unique identifier for this event.

accountId
string

The account identifier associated with this event.

dateCreated
string

The ISO 8601 timestamp when the event was created.

resource
string

The resource type that is contained in the event data.

resourceUri
string

The URI to the specific resource that is contained in the event data.

subscriptionResourceUri
string

The URI of the subscribed resource that generated this event. For example, when subscribed to a scoreboard, events for its child resources (clocks, overlays, etc.) will show the scoreboard URI here while resourceUri shows the specific resource provided in the event data.

action
string

The action that triggered the event. Possible values: "created", "updated", "deleted", "read".

data
object

Contains the full resource data that triggered the event. The structure varies based on the resource type specified in the 'resource' property.

Response Example

{
  "object": "event",
  "eventId": "y51a48n8qhkmsbek05",
  "accountId": "m30540120",
  "resource": "clock",
  "resourceUri": "/scoreboards/m5ezyvgavd2pfb/clocks/play",
  "subscriptionResourceUri": "/scoreboards/m5ezyvgavd2pfb",
  "action": "updated",
  "dateCreated": "2025-10-24T17:27:17.972Z",
  "data": {
    "object": "clock",
    "url": "https://api.scoreboardmax.com/api/v1/scoreboards/m5ezyvgavd2pfb/clocks/play",
    "accountId": "M30540120",
    "asOfTimestamp": 1761326837963,
    "ascending": false,
    "clockId": "play",
    "display": "0:25",
    "nowTimestamp": 1761326837972,
    "running": false,
    "scoreboardId": "m5ezyvgavd2pfb",
    "seconds": 25,
    "stopAt": 0,
    "uri": "/scoreboards/m5ezyvgavd2pfb/clocks/play"
  }
}

Error

Properties

error
boolean

Always true for error responses

code
string

The specific error code identifying the type of error. Possible values: "ForbiddenSelfPermissionsChange", "InsufficientAdminPermissions", "InsufficientItemPermissions", "InsufficientResourcePermissions", "InsufficientResourceItemPermissions", "InvalidAuthType", "InvalidColorFormat", "InvalidDate", "InvalidInput", "InvalidRequest", "InvalidPermissionGrant", "InvalidSignIn", "InvalidAccountSignIn", "InvalidToken", "AccountLimitExceeded", "AccountStorageExceeded", "ActiveScoreboardsExceeded", "AccountFeatureNotEnabled", "ImageProcessingError", "RemoteServerError", "RemoteServerTimeout", "RequestLimitExceeded", "ResourceNotFound", "UserCredentialsInUse", "AccountEmailInUse", "IncompatibleState", "UnspecifiedError", "VersionConflict"

message
string

A human-readable error message describing what went wrong

statusCode
number

The HTTP status code associated with this error

reference
string

A unique reference identifier for this specific error occurrence, useful for support and debugging

Response Example

{
  "error": true,
  "code": "ResourceNotFound",
  "message": "The requested resource was not found: scoreboard: c3qxrt7caknrwr1",
  "statusCode": 404,
  "reference": "GY3KgCP"
}

BaseballData

Properties

balls
numbernullable

Current number of balls for the at-bat

inning
number

Current inning number

inningSegment
string

Current segment of the inning. Possible values: "top", "middle", "bottom", "end"

outs
numbernullable

Current number of outs in the inning

runnerOnFirst
boolean

Whether there is a runner on first base

runnerOnSecond
boolean

Whether there is a runner on third base

runnerOnThird
boolean

Whether there is a runner on third base

settings
BaseballSettings

Baseball-specific settings for the scoreboard

strikes
numbernullable

Current number of strikes for the at-bat

team1
BaseballScoreboardTeam

First team data and statistics

team2
BaseballScoreboardTeam

Second team data and statistics

type
string

The type of scoreboard, always "baseball" for this resource

Response Example

{
  "balls": 0,
  "inning": 1,
  "inningSegment": "top",
  "outs": 0,
  "runnerOnFirst": false,
  "runnerOnSecond": false,
  "runnerOnThird": false,
  "settings": {
    "clockAscending": false,
    "enableClockAutomations": true,
    "enableKeyboardShortcuts": true,
    "pitchClockLength": 20,
    "showAccountLogo": true,
    "showBaseRunners": true,
    "showBattingAverage": false,
    "showCount": true,
    "showLineScore": true,
    "showPitchClock": true,
    "showPitchClockWhenLow": true,
    "showPitchCount": false,
    "showSponsors": true,
    "sponsorFilter": []
  },
  "strikes": 0,
  "team1": {
    "abbreviation": "HAW",
    "batter": null,
    "battingList": [],
    "battingRecord": {},
    "color": "#ffcb05",
    "description": null,
    "errors": 0,
    "hits": 0,
    "inningRuns": [],
    "isHomeTeam": true,
    "logoFilename": "d58a4e00-811e-410f-8237-f97d03f633fd.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/d58a4e00-811e-410f-8237-f97d03f633fd_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/d58a4e00-811e-410f-8237-f97d03f633fd.avif",
    "name": "Hawks",
    "pitchCount": {},
    "pitcher": null,
    "reference": "mcmvt8vr9r",
    "roster": null,
    "rosterId": null,
    "runs": 0,
    "team": null,
    "teamId": null
  },
  "team2": {
    "abbreviation": "WOL",
    "batter": null,
    "battingList": [],
    "battingRecord": {},
    "color": "#081137",
    "description": null,
    "errors": 0,
    "hits": 0,
    "inningRuns": [],
    "isHomeTeam": false,
    "logoFilename": "b4eb1273-3448-4528-951f-728ec620d5b1.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/b4eb1273-3448-4528-951f-728ec620d5b1_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/b4eb1273-3448-4528-951f-728ec620d5b1.avif",
    "name": "Wolves",
    "pitchCount": {},
    "pitcher": null,
    "reference": "asg57v776vp",
    "roster": null,
    "rosterId": null,
    "runs": 0,
    "team": null,
    "teamId": null
  },
  "type": "baseball"
}

BaseballScoreboardTeam

Properties

abbreviation
string

Abbreviated team name

batter
PlayerSummarynullable

The current batter for the team

battingList
array of PlayerSummary

List of players in the batting order

battingRecord
object

Record of batting results for each player

color
string

Team color in hex format

description
stringnullable

Team description

errors
number

Number of errors committed by the team

hits
number

Number of hits by the team

inningRuns
array of number

Array of runs scored in each inning

isHomeTeam
boolean

Indicates if this is the home team

logoFilename
stringnullable

Filename of the team logo

logoPreviewUrl
stringnullable

URL for the preview version of the team logo

logoUrl
stringnullable

URL for the team logo

name
string

Team name

pitchCount
object

Record of pitch counts by type

pitcher
PlayerSummarynullable

The current pitcher for the team

reference
string

External reference or ID for the team

roster
string | Rosterexpandablenullable

The roster associated with the team

rosterId
stringnullable

ID of the roster associated with the team

runs
number

Total runs scored by the team

team
string | Teamexpandablenullable

The team details

teamId
stringnullable

ID of the team

Response Example

{
  "abbreviation": "HAW",
  "batter": null,
  "battingList": [],
  "battingRecord": {},
  "color": "#ffcb05",
  "description": null,
  "errors": 0,
  "hits": 0,
  "inningRuns": [],
  "isHomeTeam": true,
  "logoFilename": "d58a4e00-811e-410f-8237-f97d03f633fd.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/d58a4e00-811e-410f-8237-f97d03f633fd_p.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/d58a4e00-811e-410f-8237-f97d03f633fd.avif",
  "name": "Hawks",
  "pitchCount": {},
  "pitcher": null,
  "reference": "mcmvt8vr9r",
  "roster": null,
  "rosterId": null,
  "runs": 0,
  "team": null,
  "teamId": null
}

BaseballSettings

Properties

clockAscending
boolean

Controls the clock direction. Set to true to count up (from 0), or false to count down (towards 0).

enableClockAutomations
boolean

Enables automatic clock management based on game events and periods.

enableKeyboardShortcuts
boolean

Enables keyboard shortcuts for scoreboard controls on devices with physical keyboards.

pitchClockLength
numberoptional

The duration of the pitch clock in seconds. This is the time limit for the pitcher to deliver a pitch.

showAccountLogo
boolean

Displays the account logo, if provided, on the scoreboard if enabled.

showBaseRunners
boolean

Controls whether base runner indicators are displayed on the scoreboard.

showBattingAverage
boolean

Controls whether the current batter's batting average is displayed on the scoreboard.

showCount
boolean

Controls whether the ball and strike count is displayed on the scoreboard.

showLineScore
boolean

Controls whether the line score (runs per inning) is displayed on the scoreboard.

showPitchClock
boolean

Controls whether the pitch clock is displayed on the scoreboard.

showPitchClockWhenLow
boolean

Controls whether the pitch clock is highlighted or more prominently displayed when time is running low.

showPitchCount
boolean

Controls whether the current pitcher's pitch count is displayed on the scoreboard.

showSponsors
boolean

Displays sponsor logos, if any, on the scoreboard in a rotating sequence.

sponsorFilter
array of stringnullable

Limits sponsor display to the specified sponsorIds. Leave empty or set to null to show all sponsors without filtering.

Response Example

{
  "clockAscending": false,
  "enableClockAutomations": true,
  "enableKeyboardShortcuts": true,
  "pitchClockLength": 20,
  "showAccountLogo": true,
  "showBaseRunners": true,
  "showBattingAverage": false,
  "showCount": true,
  "showLineScore": true,
  "showPitchClock": true,
  "showPitchClockWhenLow": true,
  "showPitchCount": false,
  "showSponsors": true,
  "sponsorFilter": []
}

BasketballData

Properties

period
string

The current period of the basketball game. Possible values: "pregame", "1", "2", "half", "3", "4", "overtime"

settings
BasketballSettings

Basketball-specific settings for the scoreboard

team1
BasketballScoreboardTeam

The first team's basketball-specific data

team2
BasketballScoreboardTeam

The second team's basketball-specific data

type
string

The type of scoreboard, always "basketball" for basketball data

Response Example

{
  "period": "1",
  "settings": {
    "bonusThreshold": 5,
    "clockAscending": false,
    "enableClockAutomations": true,
    "enableKeyboardShortcuts": true,
    "gamePeriods": "quarters",
    "halfLength": 600,
    "hasDoubleBonus": false,
    "periodLength": 480,
    "shotClockLength": 35,
    "shotClockSecondaryLength": 20,
    "showAccountLogo": true,
    "showGameClock": true,
    "showShotClock": false,
    "showShotClockWhenLow": false,
    "showSponsors": true,
    "showTeamFouls": true,
    "showTimeouts": true,
    "sponsorFilter": [],
    "timeoutAllocation": "perGame",
    "timeoutsTotal": 5
  },
  "team1": {
    "abbreviation": "CH",
    "bonus": false,
    "color": "#7BAFD4",
    "description": null,
    "doubleBonus": false,
    "fouls": 0,
    "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
    "name": "Cedar Hill",
    "possession": false,
    "reference": "ij7301i8bm",
    "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
    "rosterId": null,
    "score": 0,
    "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
    "teamId": "6jm32ffm1",
    "timeoutsLeft": 3
  },
  "team2": {
    "abbreviation": "WES",
    "bonus": false,
    "color": "#b9271d",
    "description": null,
    "doubleBonus": false,
    "fouls": 0,
    "logoFilename": "9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
    "name": "Westbrook",
    "possession": false,
    "reference": "6nwkbrpkksu",
    "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
    "rosterId": "jyxdhd9cx",
    "score": 0,
    "team": "https://api.scoreboardmax.com/api/v1/teams/8tm5fzpnc",
    "teamId": "8tm5fzpnc",
    "timeoutsLeft": 3
  },
  "type": "basketball"
}

BasketballScoreboardTeam

Properties

abbreviation
string

The team's abbreviation

bonus
boolean

Indicates if the team is in bonus situation

color
string

The team's primary color in hex format

description
stringnullable

Description of the team

doubleBonus
boolean

Indicates if the team is in double bonus situation

fouls
number

The number of team fouls

logoFilename
stringnullable

The filename of the team's logo

logoPreviewUrl
stringnullable

URL to the preview version of the team's logo

logoUrl
stringnullable

URL to the team's logo

name
string

The team's name

possession
boolean

Indicates if the team currently has possession of the ball

reference
string

An external reference or ID for the team

roster
string | Rosterexpandablenullable

Reference to the roster associated with this team

rosterId
stringnullable

The ID of the roster associated with this team

score
number

The team's current score

team
string | Teamexpandablenullable

Reference to the team associated with this scoreboard team

teamId
stringnullable

The ID of the team associated with this scoreboard team

timeoutsLeft
number

The number of timeouts remaining for the team

Response Example

{
  "abbreviation": "CH",
  "bonus": false,
  "color": "#7BAFD4",
  "description": null,
  "doubleBonus": false,
  "fouls": 0,
  "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "name": "Cedar Hill",
  "possession": false,
  "reference": "ij7301i8bm",
  "roster": null,
  "rosterId": null,
  "score": 0,
  "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
  "teamId": "6jm32ffm1",
  "timeoutsLeft": 3
}

BasketballSettings

Properties

bonusThreshold
numberoptional

The team foul threshold for bonus free throw situations

clockAscending
boolean

Controls the clock direction. Set to true to count up (from 0), or false to count down (towards 0).

doubleBonusThreshold
numberoptional

The team foul threshold for double bonus free throw situations

enableClockAutomations
boolean

Enables automatic clock management features during gameplay

enableKeyboardShortcuts
boolean

Enables keyboard shortcuts for scoreboard controls on devices with physical keyboards.

gamePeriods
string

The game period structure. Possible values: "quarters", "halves"

halfLength
number

The length of halftime, in seconds

hasDoubleBonus
boolean

Whether the game uses double bonus free throw rules

periodLength
number

The length of each period in seconds

shotClockLength
numberoptional

The primary shot clock duration in seconds

shotClockSecondaryLength
numberoptional

The secondary shot clock duration in seconds (typically used after offensive rebounds)

showAccountLogo
boolean

Displays the account logo, if provided, on the scoreboard if enabled.

showGameClock
boolean

Whether to display the game clock on the scoreboard

showShotClock
boolean

Whether to display the shot clock on the scoreboard

showShotClockWhenLow
boolean

Whether to only show the shot clock when time is running low

showSponsors
boolean

Displays sponsor logos, if any, on the scoreboard in a rotating sequence.

showTeamFouls
boolean

Whether to display team foul counts on the scoreboard

showTimeouts
boolean

Whether to display timeout counts on the scoreboard

sponsorFilter
array of stringnullable

Limits sponsor display to the specified sponsorIds. Leave empty or set to null to show all sponsors without filtering.

timeoutAllocation
stringoptional

How timeouts are allocated. Possible values: "perGame", "perHalf"

timeoutsFirstHalf
numberoptional

Number of timeouts available in the first half (when timeoutAllocation is perHalf)

timeoutsSecondHalf
numberoptional

Number of timeouts available in the second half (when timeoutAllocation is perHalf)

timeoutsTotal
numberoptional

Total number of timeouts available for the entire game (when timeoutAllocation is perGame)

Response Example

{
  "bonusThreshold": 5,
  "clockAscending": false,
  "enableClockAutomations": true,
  "enableKeyboardShortcuts": true,
  "gamePeriods": "quarters",
  "halfLength": 600,
  "hasDoubleBonus": false,
  "periodLength": 480,
  "shotClockLength": 35,
  "shotClockSecondaryLength": 20,
  "showAccountLogo": true,
  "showGameClock": true,
  "showShotClock": false,
  "showShotClockWhenLow": false,
  "showSponsors": true,
  "showTeamFouls": true,
  "showTimeouts": true,
  "sponsorFilter": [],
  "timeoutAllocation": "perGame",
  "timeoutsTotal": 5
}

FootballData

Properties

distanceToGo
stringnullable

The distance needed for a first down or touchdown, displayed as text (e.g., 'Goal', '10')

down
numbernullable

The current down number (1-4)

flag
boolean

Indicates if a penalty flag is thrown

period
string

The current game period. Possible values: "pregame", "1", "2", "half", "3", "4", "overtime"

settings
FootballSettings

Football-specific settings for the scoreboard

team1
FootballScoreboardTeam

First team data including score, timeouts, and possession information

team2
FootballScoreboardTeam

Second team data including score, timeouts, and possession information

type
string

The type of scoreboard, always "football" for football data

Response Example

{
  "data": {
    "distanceToGo": null,
    "down": null,
    "flag": false,
    "period": "1",
    "settings": {
      "clockAscending": false,
      "clockStopsOnFirstDown": true,
      "downAndDistanceDisplay": "both",
      "enableClockAutomations": true,
      "enableKeyboardShortcuts": true,
      "enableMercyRule": false,
      "halfLength": 900,
      "hideFlagAfter": 25,
      "periodLength": 720,
      "playClockLength": 40,
      "playClockSecondaryLength": 25,
      "showAccountLogo": true,
      "showGameClock": true,
      "showPlayClock": false,
      "showPlayClockWhenLow": false,
      "showPossession": true,
      "showSponsors": true,
      "showTimeouts": true,
      "sponsorFilter": [],
      "timeoutsPerHalf": 3
    },
    "team1": {
      "abbreviation": "WES",
      "color": "#b9271d",
      "description": null,
      "logoFilename": "9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
      "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e_p.avif",
      "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
      "name": "Westbrook",
      "possession": false,
      "reference": "hvnq0wuhhow",
      "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
      "rosterId": "jyxdhd9cx",
      "score": 0,
      "team": "https://api.scoreboardmax.com/api/v1/teams/8tm5fzpnc",
      "teamId": "8tm5fzpnc",
      "timeoutsLeft": 3
    },
    "team2": {
      "abbreviation": "CH",
      "color": "#7BAFD4",
      "description": null,
      "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
      "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
      "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
      "name": "Cedar Hill",
      "possession": false,
      "reference": "axby0aq5q6i",
      "roster": null,
      "rosterId": null,
      "score": 0,
      "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
      "teamId": "6jm32ffm1",
      "timeoutsLeft": 3
    },
    "type": "football"
  }
}

FootballScoreboardTeam

Properties

abbreviation
string

The abbreviated name of the team, typically derived from the team name.

color
string

The team's primary color in hexadecimal format.

description
stringnullable

Optional description or additional information about the team.

logoFilename
stringnullable

The filename of the team's logo image.

logoPreviewUrl
stringnullable

URL to a preview-sized version of the team's logo image.

logoUrl
stringnullable

URL to the full-sized team logo image.

name
string

The name of the team.

possession
boolean

Indicates whether this team currently has possession of the ball.

reference
string

An external reference or ID for the team, used by the client.

roster
string | Rosterexpandablenullable

URL to the roster resource, or the expanded roster object if requested.

rosterId
stringnullable

The ID of the roster associated with this team.

score
number

The current score for this team.

team
string | Teamexpandablenullable

URL to the team resource, or the expanded team object if requested.

teamId
stringnullable

The unique identifier of the team.

timeoutsLeft
number

The number of timeouts remaining for this team.

Response Example

{
  "abbreviation": "WES",
  "color": "#b9271d",
  "description": null,
  "logoFilename": "9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e_p.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
  "name": "Westbrook",
  "possession": false,
  "reference": "hvnq0wuhhow",
  "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
  "rosterId": "jyxdhd9cx",
  "score": 0,
  "team": "https://api.scoreboardmax.com/api/v1/teams/8tm5fzpnc",
  "teamId": "8tm5fzpnc",
  "timeoutsLeft": 3
}

FootballSettings

Properties

clockAscending
boolean

Controls the clock direction. Set to true to count up (from 0), or false to count down (towards 0).

clockStopsOnFirstDown
boolean

Determines if the game clock automatically stops when a first down is achieved.

downAndDistanceDisplay
string

Controls the display of down and distance information. Possible values: "both", "downOnly", "none".

enableClockAutomations
boolean

Enables automatic clock management features such as stopping on incomplete passes or out of bounds plays.

enableKeyboardShortcuts
boolean

Enables keyboard shortcuts for scoreboard controls on devices with physical keyboards.

enableMercyRule
boolean

Enables mercy rule functionality to automatically end games when score differential becomes excessive.

halfLength
number

The length of halftime in seconds.

hideFlagAfter
number

Number of seconds after which a penalty flag indication is automatically hidden from the display.

periodLength
number

The length of each quarter/period in seconds.

playClockLength
numberoptional

The primary play clock duration in seconds.

playClockSecondaryLength
numberoptional

The secondary play clock duration in seconds, used in specific game situations.

showAccountLogo
boolean

Displays the account logo, if provided, on the scoreboard if enabled.

showGameClock
boolean

Controls whether the game clock is displayed on the scoreboard.

showPlayClock
boolean

Controls whether the play clock is displayed on the scoreboard.

showPlayClockWhenLow
boolean

Shows the play clock only when the time remaining is below a certain threshold.

showPossession
boolean

Controls whether the possession indicator is displayed on the scoreboard.

showSponsors
boolean

Displays sponsor logos, if any, on the scoreboard in a rotating sequence.

showTimeouts
boolean

Controls whether timeout information is displayed on the scoreboard.

sponsorFilter
array of stringnullable

Limits sponsor display to the specified sponsorIds. Leave empty or set to null to show all sponsors without filtering.

timeoutsPerHalf
numberoptional

The number of timeouts each team receives per half.

Response Example

{
  "clockAscending": false,
  "clockStopsOnFirstDown": true,
  "downAndDistanceDisplay": "both",
  "enableClockAutomations": true,
  "enableKeyboardShortcuts": true,
  "enableMercyRule": false,
  "halfLength": 900,
  "hideFlagAfter": 25,
  "periodLength": 720,
  "playClockLength": 40,
  "playClockSecondaryLength": 25,
  "showAccountLogo": true,
  "showGameClock": true,
  "showPlayClock": false,
  "showPlayClockWhenLow": false,
  "showPossession": true,
  "showSponsors": true,
  "showTimeouts": true,
  "sponsorFilter": [],
  "timeoutsPerHalf": 3
}

SoccerData

Properties

period
string

The current period of the soccer match. Possible values: "pregame", "1", "2", "half", "3", "4", "ET 1", "ET 2", "shootout"

settings
SoccerSettings

Soccer-specific settings for the scoreboard

team1
SoccerScoreboardTeam

Data for the first team

team2
SoccerScoreboardTeam

Data for the second team

type
string

The type of scoreboard, always "soccer" for soccer data

Response Example

{
  "period": "1",
  "settings": {
    "clockAscending": false,
    "enableKeyboardShortcuts": true,
    "extraTimeLabel": "ET",
    "extraTimeLength": 900,
    "gamePeriods": "halves",
    "halfLength": 900,
    "hasStoppageTime": true,
    "hidePenaltyCardAfter": 25,
    "periodLength": 2700,
    "showAccountLogo": true,
    "showGameClock": true,
    "showSponsors": true,
    "sponsorFilter": []
  },
  "team1": {
    "abbreviation": "CH",
    "color": "#7BAFD4",
    "description": null,
    "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
    "name": "Cedar Hill",
    "reference": "addtxxcug78",
    "roster": null,
    "rosterId": null,
    "score": 0,
    "shootoutResults": [],
    "shootoutScore": 0,
    "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
    "teamId": "6jm32ffm1"
  },
  "team2": {
    "abbreviation": "WES",
    "color": "#b9271d",
    "description": null,
    "logoFilename": "9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
    "name": "Westbrook",
    "reference": "xytswbq7lqa",
    "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
    "rosterId": "jyxdhd9cx",
    "score": 0,
    "shootoutResults": [],
    "shootoutScore": 0,
    "team": "https://api.scoreboardmax.com/api/v1/teams/8tm5fzpnc",
    "teamId": "8tm5fzpnc"
  },
  "type": "soccer"
}

SoccerScoreboardTeam

Properties

abbreviation
string

Abbreviated name or acronym for the team, typically derived from the team name.

color
string

Hex color code for the team.

description
stringnullable

Description for the team.

logoFilename
stringnullable

Filename of the team logo image.

logoPreviewUrl
stringnullable

URL for the preview-sized team logo image.

logoUrl
stringnullable

URL for the full-sized team logo image.

name
string

Name of the team.

penaltyCard
SoccerPenaltyCardoptional

Active penalty card for the team, if any.

reference
string

External reference or ID for the team, used by the client.

roster
string | Rosterexpandablenullable

URL to the roster resource associated with this team, or the expanded roster object if requested.

rosterId
stringnullable

ID of the roster associated with this team.

score
number

Current score for the team in regular play.

shootoutResults
array of booleannullable

Array of penalty shootout results. Each element represents a penalty kick: true for goal, false for miss, null for not yet taken.

shootoutScore
number

Current score for the team in the penalty shootout phase.

team
string | Teamexpandablenullable

URL to the team resource, or the expanded team object if requested.

teamId
stringnullable

ID of the team resource associated with this scoreboard team.

Response Example

{
  "abbreviation": "CH",
  "color": "#7BAFD4",
  "description": null,
  "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "name": "Cedar Hill",
  "reference": "addtxxcug78",
  "roster": null,
  "rosterId": null,
  "score": 0,
  "shootoutResults": [],
  "shootoutScore": 0,
  "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
  "teamId": "6jm32ffm1"
}

SoccerSettings

Properties

clockAscending
boolean

Controls the clock direction. Set to true to count up (from 0), or false to count down (towards 0).

enableKeyboardShortcuts
boolean

Enables keyboard shortcuts for scoreboard controls on devices with physical keyboards.

extraTimeLabel
string

The label displayed for extra time periods. Possible values: "ET", "OT".

extraTimeLength
number

The length of each extra time period in seconds.

gamePeriods
string

The period structure for the game. Possible values: "quarters", "halves".

halfLength
number

The length of halftime break in seconds.

hasStoppageTime
boolean

Indicates whether the game includes stoppage time (injury time) periods.

hidePenaltyCardAfter
number

The number of seconds after which penalty cards are automatically hidden from display.

periodLength
number

The length of each game period in seconds.

showAccountLogo
boolean

Displays the account logo, if provided, on the scoreboard if enabled.

showGameClock
boolean

Controls whether the game clock is displayed on the scoreboard.

showSponsors
boolean

Displays sponsor logos, if any, on the scoreboard in a rotating sequence.

sponsorFilter
array of stringnullable

Limits sponsor display to the specified sponsorIds. Leave empty or set to null to show all sponsors without filtering.

Response Example

{
  "clockAscending": false,
  "enableKeyboardShortcuts": true,
  "extraTimeLabel": "ET",
  "extraTimeLength": 900,
  "gamePeriods": "halves",
  "halfLength": 900,
  "hasStoppageTime": true,
  "hidePenaltyCardAfter": 25,
  "periodLength": 2700,
  "showAccountLogo": true,
  "showGameClock": true,
  "showSponsors": true,
  "sponsorFilter": []
}

VolleyballData

Properties

set
numbernullable

The current set number in the volleyball match

settings
VolleyballSettings

Volleyball-specific settings for the scoreboard

team1
VolleyballScoreboardTeam

The first team's volleyball-specific data

team2
VolleyballScoreboardTeam

The second team's volleyball-specific data

type
string

The type of scoreboard, always 'volleyball' for this data structure

Response Example

{
  "accountId": "M30540120",
  "accountLogoPreviewUrl": null,
  "accountLogoUrl": null,
  "clocks": "https://api.scoreboardmax.com/api/v1/scoreboards/p1ukfy2bxcmavb/clocks",
  "controlUrl": "https://app.scoreboardmax.com/scoreboard/p1ukfy2bxcmavb/control",
  "currentServerTimestamp": 1754338970,
  "data": {
    "set": 1,
    "settings": {
      "clockAscending": false,
      "enableKeyboardShortcuts": true,
      "sets": 5,
      "showAccountLogo": true,
      "showServing": true,
      "showSponsors": true,
      "showTimeouts": true,
      "sponsorFilter": [],
      "timeoutsPerSet": 2
    },
    "team1": {
      "abbreviation": "CH",
      "color": "#7BAFD4",
      "description": null,
      "finalSetScores": [],
      "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
      "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
      "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
      "matchScore": 0,
      "name": "Cedar Hill",
      "reference": "k1t82b049y",
      "roster": null,
      "rosterId": null,
      "server": null,
      "serving": false,
      "setScore": 0,
      "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
      "teamId": "6jm32ffm1",
      "timeoutsLeft": 2
    },
    "team2": {
      "abbreviation": "WES",
      "color": "#b9271d",
      "description": null,
      "finalSetScores": [],
      "logoFilename": "9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
      "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e_p.avif",
      "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
      "matchScore": 0,
      "name": "Westbrook",
      "reference": "ao1k486fvf",
      "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
      "rosterId": "jyxdhd9cx",
      "server": null,
      "serving": false,
      "setScore": 0,
      "team": "https://api.scoreboardmax.com/api/v1/teams/8tm5fzpnc",
      "teamId": "8tm5fzpnc",
      "timeoutsLeft": 2
    },
    "type": "volleyball"
  },
  "dateCreated": "2025-08-04T20:22:35.171Z",
  "dateModified": "2025-08-04T20:22:50.359Z",
  "description": "Volleyball - Cedar Hill vs Westbrook",
  "embedUrl": "https://app.scoreboardmax.com/scoreboard/p1ukfy2bxcmavb/embed?token=SizIIUx8SCSNkSR4L1vWyyKRL6aNiMqB",
  "name": null,
  "object": "scoreboard",
  "overlay": "https://api.scoreboardmax.com/api/v1/scoreboards/p1ukfy2bxcmavb/overlay",
  "scoreboardId": "p1ukfy2bxcmavb",
  "type": "volleyball",
  "uri": "/scoreboards/p1ukfy2bxcmavb",
  "url": "https://api.scoreboardmax.com/api/v1/scoreboards/p1ukfy2bxcmavb"
}

VolleyballScoreboardTeam

Properties

abbreviation
string

The team's abbreviated name

color
string

The team's primary color in hexadecimal format

description
stringnullable

A brief description of the team

finalSetScores
array of numbernullable

Array of scores for completed sets

logoFilename
stringnullable

The filename of the team's logo image

logoPreviewUrl
stringnullable

URL to the preview version of the team's logo image

logoUrl
stringnullable

URL to the team's logo image

matchScore
number

The number of sets won by this team in the match

name
string

The team name

reference
string

An external reference or ID for the team

roster
string | Rosterexpandablenullable

The roster associated with this team, or URL to the roster resource

rosterId
stringnullable

The ID of the roster associated with this team

server
PlayerSummarynullable

The player currently serving for this team

serving
boolean

Whether this team is currently serving

setScore
number

The current score for this team in the active set

team
string | Teamexpandablenullable

The team resource, or URL to the team resource

teamId
stringnullable

The ID of the team

timeoutsLeft
number

The number of timeouts remaining for this team in the current set

Response Example

{
  "abbreviation": "CH",
  "color": "#7BAFD4",
  "description": null,
  "finalSetScores": [],
  "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "matchScore": 0,
  "name": "Cedar Hill",
  "reference": "k1t82b049y",
  "roster": null,
  "rosterId": null,
  "server": null,
  "serving": false,
  "setScore": 0,
  "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
  "teamId": "6jm32ffm1",
  "timeoutsLeft": 2
}

VolleyballSettings

Properties

clockAscending
boolean

Controls the clock direction. Set to true to count up (from 0), or false to count down (towards 0).

enableKeyboardShortcuts
boolean

Enables keyboard shortcuts for scoreboard controls on devices with physical keyboards.

sets
number

The number of sets in the volleyball match.

showAccountLogo
boolean

Displays the account logo, if provided, on the scoreboard if enabled.

showServing
boolean

Displays which team is currently serving on the scoreboard.

showSponsors
boolean

Displays sponsor logos, if any, on the scoreboard in a rotating sequence.

showTimeouts
boolean

Displays the number of timeouts remaining for each team on the scoreboard.

sponsorFilter
array of stringnullable

Limits sponsor display to the specified sponsorIds. Leave empty or set to null to show all sponsors without filtering.

timeoutsPerSet
numberoptional

The number of timeouts each team gets per set.

Response Example

{
  "clockAscending": false,
  "enableKeyboardShortcuts": true,
  "sets": 5,
  "showAccountLogo": true,
  "showServing": true,
  "showSponsors": true,
  "showTimeouts": true,
  "sponsorFilter": [],
  "timeoutsPerSet": 2
}

WrestlingData

Properties

type
string

The type of scoreboard data. Always "wrestling" for wrestling scoreboards.

period
string

Current wrestling period. Possible values: "1", "2", "3", "overtime"

overtimePhase
WrestlingOvertimePhasenullable

Current overtime phase information, if applicable

team1
WrestlingScoreboardTeam

First team's wrestling-specific data

team2
WrestlingScoreboardTeam

Second team's wrestling-specific data

teamIds
array of string

Array of team IDs associated with this wrestling match

weightClass
stringnullable

Current weight class being wrestled

tournamentTeams
array of WrestlingScoreboardTeam

Array of teams for tournament-style wrestling meets

settings
WrestlingSettings

Wrestling-specific settings and configurations

Response Example

{
  "overtimePhase": null,
  "period": "1",
  "settings": {
    "bandColors": [
      "red",
      "green"
    ],
    "clockAscending": false,
    "enableKeyboardShortcuts": true,
    "hasUltimateTieBreaker": true,
    "meetType": "dual",
    "periodCount": 3,
    "periodLength": 120,
    "showAccountLogo": true,
    "showPeriodClock": true,
    "showSponsors": true,
    "sponsorFilter": [],
    "style": "folkstyle",
    "suddenVictoryLength": 60,
    "tieBreakerLength": 30,
    "trackTeamScores": true,
    "ultimateTieBreakerLength": 30,
    "weightType": "lb"
  },
  "team1": {
    "abbreviation": "CH",
    "bandColor": null,
    "color": "#7BAFD4",
    "description": null,
    "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
    "matchScore": 0,
    "name": "Cedar Hill",
    "reference": "0tpvords3thb",
    "roster": null,
    "rosterId": null,
    "score": 0,
    "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
    "teamId": "6jm32ffm1",
    "wrestler": null
  },
  "team2": {
    "abbreviation": "WES",
    "bandColor": null,
    "color": "#b9271d",
    "description": null,
    "logoFilename": "9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
    "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e_p.avif",
    "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/9d92f5e9-8fa5-40b6-87fe-11973034f92e.avif",
    "matchScore": 0,
    "name": "Westbrook",
    "reference": "6ijst36jye8",
    "roster": "https://api.scoreboardmax.com/api/v1/rosters/jyxdhd9cx",
    "rosterId": "jyxdhd9cx",
    "score": 0,
    "team": "https://api.scoreboardmax.com/api/v1/teams/8tm5fzpnc",
    "teamId": "8tm5fzpnc",
    "wrestler": null
  },
  "teamIds": [],
  "tournamentTeams": [],
  "type": "wrestling",
  "weightClass": null
}

WrestlingScoreboardTeam

Properties

abbreviation
string

The abbreviated name of the team

bandColor
stringnullable

The band color for the wrestler. Possible values: "red", "blue", "green"

color
string

The team's primary color in hex format

description
stringnullable

Optional description for the team

logoFilename
stringnullable

The filename of the team's logo image

logoPreviewUrl
stringnullable

URL to the preview version of the team's logo image

logoUrl
stringnullable

URL to the team's logo image

matchScore
number

The team's match score in the wrestling meet

name
string

The team name

reference
string

An external reference or ID for the team

roster
string | Rosterexpandablenullable

URL to the roster associated with this team, or the roster object if expanded

rosterId
stringnullable

The ID of the roster associated with this team

score
number

The team's current score in the wrestling match

team
string | Teamexpandablenullable

URL to the team resource, or the team object if expanded

teamId
stringnullable

The unique identifier of the team

wrestler
PlayerSummarynullable

The current wrestler competing for this team

Response Example

{
  "abbreviation": "CH",
  "bandColor": null,
  "color": "#7BAFD4",
  "description": null,
  "logoFilename": "6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "logoPreviewUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778_p.avif",
  "logoUrl": "https://cdn.scoreboardmax.com/m30540120/teamLogo/6767fc60-cd23-457f-bfba-41089d6f1778.avif",
  "matchScore": 0,
  "name": "Cedar Hill",
  "reference": "0tpvords3thb",
  "roster": null,
  "rosterId": null,
  "score": 0,
  "team": "https://api.scoreboardmax.com/api/v1/teams/6jm32ffm1",
  "teamId": "6jm32ffm1",
  "wrestler": null
}

WrestlingSettings

Properties

bandColors
array of string

Array of band colors used to identify wrestlers. Possible values: "red", "green", "blue"

clockAscending
boolean

Controls the clock direction. Set to true to count up (from 0), or false to count down (towards 0).

enableKeyboardShortcuts
boolean

Enables keyboard shortcuts for scoreboard controls on devices with physical keyboards.

hasUltimateTieBreaker
boolean

Determines whether ultimate tie breaker periods are enabled for this match

initialPeriodLength
numberoptional

Length of the initial period in seconds, if different from regular periods

meetType
string

Type of wrestling meet. Possible values: "dual", "tournament"

periodCount
number

Total number of regular periods in the match

periodLength
number

Length of each regular period in seconds

showAccountLogo
boolean

Displays the account logo, if provided, on the scoreboard if enabled.

showPeriodClock
boolean

Controls whether the period clock is displayed on the scoreboard

showSponsors
boolean

Displays sponsor logos, if any, on the scoreboard in a rotating sequence.

sponsorFilter
array of stringnullable

Limits sponsor display to the specified sponsorIds. Leave empty or set to null to show all sponsors without filtering.

style
string

Wrestling style being used. Possible values: "freestyle", "greco", "folkstyle"

suddenVictoryLength
numberoptional

Length of sudden victory overtime periods in seconds

tieBreakerLength
numberoptional

Length of tie breaker periods in seconds

trackTeamScores
boolean

Enables tracking of cumulative team scores across multiple matches

ultimateTieBreakerLength
numberoptional

Length of ultimate tie breaker periods in seconds

weightType
string

Unit of measurement for weight classes. Possible values: "kg", "lb"

Response Example

{
  "bandColors": [
    "red",
    "green"
  ],
  "clockAscending": false,
  "enableKeyboardShortcuts": true,
  "hasUltimateTieBreaker": true,
  "meetType": "dual",
  "periodCount": 3,
  "periodLength": 120,
  "showAccountLogo": true,
  "showPeriodClock": true,
  "showSponsors": true,
  "sponsorFilter": [],
  "style": "folkstyle",
  "suddenVictoryLength": 60,
  "tieBreakerLength": 30,
  "trackTeamScores": true,
  "ultimateTieBreakerLength": 30,
  "weightType": "lb"
}