All docs

Volleyball API reference

Every volleyball endpoint of the KeepTheScore API, with its parameters, request body and responses, generated from the live API.

Keys, tokens, request bodies and rate limits are explained in the API guide. In the paths below, {token} is a board token when you send an API key, or one of the board's own tokens without one.

This page is generated from the live API. The same reference is available as OpenAPI 3 at /apispec.json, if you'd rather generate a client than read tables.

Volleyball

POST /api/v1/sport/{token}/volleyball/away/score/increment

Increment away team score for volleyball.

In simple mode: updates away.score In expanded mode: updates away.scores_in_sets[current_set - 1] Also switches serve to away team when scoring (amount > 0).

Path parameters

Name	Type	Required	Description
`token`	string	yes

Responses

Status	Meaning	Body
`200`	OK	MessageResponse
`400`	Malformed request	—
`403`	This token does not allow the board to be edited	—
`404`	Board not found	—
`429`	Too many requests	—
`500`	Internal server error	—

Response body (200) — MessageResponse (JSON)

Field	Type	Always present	Description
`message`	string	yes	Status message

POST /api/v1/sport/{token}/volleyball/away/set/increment

Increment away team sets won (simple mode).

Path parameters

Name	Type	Required	Description
`token`	string	yes

Responses

Status	Meaning	Body
`200`	OK	MessageResponse
`400`	Malformed request	—
`403`	This token does not allow the board to be edited	—
`404`	Board not found	—
`429`	Too many requests	—
`500`	Internal server error	—

Response body (200) — MessageResponse (JSON)

Field	Type	Always present	Description
`message`	string	yes	Status message

POST /api/v1/sport/{token}/volleyball/current_set/increment

Increment current set number (expanded mode).

Path parameters

Name	Type	Required	Description
`token`	string	yes

Responses

Status	Meaning	Body
`200`	OK	MessageResponse
`400`	Malformed request	—
`403`	This token does not allow the board to be edited	—
`404`	Board not found	—
`429`	Too many requests	—
`500`	Internal server error	—

Response body (200) — MessageResponse (JSON)

Field	Type	Always present	Description
`message`	string	yes	Status message

POST /api/v1/sport/{token}/volleyball/home/score/increment

Increment home team score for volleyball.

In simple mode: updates home.score In expanded mode: updates home.scores_in_sets[current_set - 1] Also switches serve to home team when scoring (amount > 0).

Path parameters

Name	Type	Required	Description
`token`	string	yes

Responses

Status	Meaning	Body
`200`	OK	MessageResponse
`400`	Malformed request	—
`403`	This token does not allow the board to be edited	—
`404`	Board not found	—
`429`	Too many requests	—
`500`	Internal server error	—

Response body (200) — MessageResponse (JSON)

Field	Type	Always present	Description
`message`	string	yes	Status message

POST /api/v1/sport/{token}/volleyball/home/set/increment

Increment home team sets won (simple mode).

Path parameters

Name	Type	Required	Description
`token`	string	yes

Responses

Status	Meaning	Body
`200`	OK	MessageResponse
`400`	Malformed request	—
`403`	This token does not allow the board to be edited	—
`404`	Board not found	—
`429`	Too many requests	—
`500`	Internal server error	—

Response body (200) — MessageResponse (JSON)

Field	Type	Always present	Description
`message`	string	yes	Status message

POST /api/v1/sport/{token}/volleyball/reset

Reset all game state to initial values for a new volleyball game.

Path parameters

Name	Type	Required	Description
`token`	string	yes

Responses

Status	Meaning	Body
`200`	OK	MessageResponse
`400`	Malformed request	—
`403`	This token does not allow the board to be edited	—
`404`	Board not found	—
`429`	Too many requests	—
`500`	Internal server error	—

Response body (200) — MessageResponse (JSON)

Field	Type	Always present	Description
`message`	string	yes	Status message

POST /api/v1/sport/{token}/volleyball/serve/toggle

Toggle serve between home and away teams.

Path parameters

Name	Type	Required	Description
`token`	string	yes

Responses

Status	Meaning	Body
`200`	OK	MessageResponse
`400`	Malformed request	—
`403`	This token does not allow the board to be edited	—
`404`	Board not found	—
`429`	Too many requests	—
`500`	Internal server error	—

Response body (200) — MessageResponse (JSON)

Field	Type	Always present	Description
`message`	string	yes	Status message