List Voting Events
Authorization
bearerAuth AuthorizationBearer <token>
A key in the form pepvote_api_ followed by 32 hexadecimal characters.
In: header
Header Parameters
User-Agentstringrequired
Name and version of the calling integration. Required on every request.
Query Parameters
limitinteger
Page size, 1 to 200. Defaults to 50.
- Default value:
50 - Minimum value:
1 - Maximum value:
200
cursorstring
Cursor from a previous response's nextCursor.
typeenum<string>
- Values:
election|poll
statusenum<string>
- Values:
draft|upcoming|ongoing|ended
Response Body
application/json
application/json
curl -X GET "https://example.com/voting-events" \ -H "User-Agent: my-app/1.0"{
"data": [
{
"id": "string",
"code": "string",
"type": "string",
"title": "string",
"desc": "string",
"startsAt": 0,
"endsAt": 0,
"status": "draft",
"locked": true,
"liveResult": true,
"publishedResult": true,
"resultDisplayLimit": 0,
"groupMode": true,
"votingFormat": "string",
"shuffleCandidates": true,
"multiStepVoting": true,
"canContestMultiplePositions": true,
"enableWeightedVoting": true,
"enablePayToVote": true,
"enablePayToRegisterCandidate": true,
"registration": {
"voterCanRegister": true,
"voterPublicRegistrationClosesAt": 0,
"candidateCanRegister": true,
"candidatePublicRegistrationClosesAt": 0,
"requireVoterId": true,
"voterIdValidationLogic": "string",
"voterIdValidatingValue": "string"
},
"aliases": {
"votingEvent": "string",
"votingCenter": "string",
"position": "string",
"group": "string",
"positionGroup": "string",
"candidateGroup": "string",
"voterGroup": "string",
"candidate": "string",
"voter": "string",
"voterId": "string",
"sponsor": "string",
"weight": "string"
},
"plan": {
"name": "string",
"maxVoters": 0
},
"logoUrl": "string",
"createdAt": 0
}
],
"nextCursor": "string"
}{
"error": {
"code": "bad_request",
"message": "string",
"details": {
"field": "string",
"parameter": "string",
"limit": 0,
"retryAfterSeconds": 0,
"feature": "string",
"plan": "string"
}
}
}Was this helpful?
Last updated September 6, 2026