GET /voting/vote-status — check the election phase

This endpoint returns the current phase of the election as a single string value. Poll it before taking phase-sensitive actions: check for register before adding voters, confirm vote_started before accepting ballot submissions, or verify vote_ended before fetching results. The value is read directly from the voting_config table and reflects real-time state.

Request

GET /voting/vote-status

No request body or query parameters are required.

Response

voting_status

string

required

The current election phase. One of three possible values:

Show possible values

string

The election has not started. Voters can be registered and the election configuration can still be updated.

vote_started

string

The election is running. Credential emails have been sent to all registered voters and ballots can now be submitted.

vote_ended

string

The election is closed. Ballots have been tallied and results are available via GET /results/tally.

HTTP status codes

Code	Meaning
`200`	Current election phase returned successfully.
`404`	No voting configuration record was found in the database.

Example

curl --request GET \
  --url https://your-api-host/voting/vote-status

{
  "voting_status": "register"
}

POST /voting/end-vote — close and tally the election

GET /results/tally — retrieve the vote count

curl --request GET \
  --url https://your-api-host/voting/vote-status

{
  "voting_status": "register"
}

Build docs developers (and LLMs) love

Get started for free Talk to us

Overview

Voters

Voting Session

Results

Configuration

GET /voting/vote-status — check the election phase

Request

Response

HTTP status codes

Example

Build docs developers (and LLMs) love

Overview

Voters

Voting Session

Results

Configuration

Documentation Index

​Request

​Response

​HTTP status codes

​Example

Build docs developers (and LLMs) love

Request

Response

HTTP status codes

Example