Skip to Content
RhythmHelp Center
/

Available Documentation

  • Platform
  • CRM
  • Portals
  • Security & Settings
  • Accreditation
  • Membership
  • Finance & Billing
  • Orders & Inventory
  • Events
  • Certifications
  • Awards
  • Careers
  • Fundraising
  • Integrations
  • Sponsorships
  • Submissions

Coming Later

  • DocumentsComing Soon
Membership
  • Overview

Subjects

  • Concepts
  • Tasks
  • Portal
  • Configure
  • Reference
    • Overview
    • Create and Maintain Elections Through the API
    • Look Up Elections Through the API
    • How Online Stores List and Sell Membership Packages
    • Record and Manage Ballots Through the API
    • Section Data Available Only Through the API
  1. Home
  2. Membership
  3. Reference

Look Up Elections Through the API

elections api ‧ read election ‧ list elections ‧ committee elections ‧ chapter elections ‧ section elections

On This Page
  • Routes
  • Reading One Election
  • Listing a Committee's Elections
  • Listing a Chapter's or a Section's Elections
  • Timing
  • Related

There is no Console screen or Portal page for looking up elections. To look up elections, call the Rhythm API directly.

You cannot list every election in your account in one request. You can read one election by its identifier, or list elections for a specific committee, chapter, or section.

Prerequisites

  • Sign in as a staff user in your Rhythm account. A Portal member sign-in is refused.

Routes ​

Method and path Purpose Notes 
GET /elections/{tenantId}/{id} Read one election's full record You must already know the election identifier; no route lists every election at once 
GET /elections/{tenantId}/committee/{committee_id} List every election held for one committee Sorted by name; returns one page of results at a time 
GET /elections/{tenantId}/chapter/{chapter_id} List every election filed under one chapter Sorted by name; returns one page of results at a time 
GET /elections/{tenantId}/section/{section_id} List every election filed under one section Sorted by name; returns one page of results at a time 

Reading One Election ​

GET /elections/{tenantId}/{id} returns the full election record. There is no bulk read, so call this route once for each identifier or use one of the listing routes below and read the identifiers it returns.

If the identifier does not exist in your account, the request is refused as not found.

Listing a Committee's Elections ​

GET /elections/{tenantId}/committee/{committee_id} returns every election held for that committee, without filtering by status, date, or type. Results are sorted by name and returned one page at a time, so follow the response's continuation token to see the full list.

Listing a Chapter's or a Section's Elections ​

The chapter and section listing routes work like the committee listing: results are sorted by name and returned one page at a time. An election's chapter and section are always copied from the election's committee (see Chapter and Section Follow the Committee), so:

  • If a committee's chapter or section changes after an election was created, the election keeps showing under its old chapter or section until you save the election again.
  • A national-type election still carries its committee's chapter, so it can appear in that chapter's listing even though it is not a chapter-level election.

Timing ​

The listings come from a search index that Rhythm updates shortly after each write. An election you just created or edited can be briefly missing from a committee, chapter, or section listing immediately afterward. Reading the election directly by its identifier does not have this delay.

Related ​

  • Create and Maintain Elections Through the API
  • Record and Manage Ballots Through the API
  • How Elections and Ballots Work

Continue in This Subject

PreviousCreate and Maintain Elections Through the APINext How Online Stores List and Sell Membership Packages

Related Articles

  • Create and Maintain Elections Through the API

    How an integration creates a committee election, what it inherits automatically from its committee, what a non-draft election requires, and how to edit or delete one.

  • Record and Manage Ballots Through the API

    How an integration records a voter's ballot in an election, corrects or removes a recorded ballot, looks up how a named voter voted, and submits many ballots in one batch request.

  • How Elections and Ballots Work

    What an election records, the difference between its positions, candidates, and measures, and how an election moves from draft through voting to a certified or cancelled result.

On This Page

  • Routes
  • Reading One Election
  • Listing a Committee's Elections
  • Listing a Chapter's or a Section's Elections
  • Timing
  • Related
Rhythm Help Center© Rhythm Software

Search article titles, settings, tasks, and troubleshooting topics. Press Enter to see results.

Browse Platform Documentation