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
Awards
  • Overview

Subjects

  • Concepts
  • Tasks
  • Portal
  • Configure
  • Reference
    • Overview
    • Fees, Coupons, and Settings Through the API
    • Batch-Update References Through the API
    • The Awards Public API
    • Where Recipient Categories Appear
  1. Home
  2. Awards
  3. Reference

The Awards Public API

awards api ‧ awards api reference ‧ awards api documentation ‧ awards api security ‧ swagger

On This Page
  • API Reference Documentation
  • Security

You use one public API address for your Rhythm account to reach every Awards operation, including award programs, nominations, applications, fees, references, reviews, and recipients.

API Reference Documentation ​

The generated API reference documentation is published at the same public address, and you do not need to sign in to read it. It covers the generated interface only, including request and response shapes, fields, and operations. Use this help center for the business rules behind those operations, such as what makes a nomination or application eligible.

Tip

If you just published or changed an API-visible form, custom field, or object, give the reference documentation up to 24 minutes to update before assuming the change did not take effect.

Security ​

The public Awards API is protected by Rhythm's platform firewall and accepts only HTTPS connections using TLS 1.2 or later. A client must negotiate at least TLS 1.2 to connect. Rhythm creates this public address only in Rhythm's primary region, so it has no address in any other region.

Continue in This Subject

PreviousBatch-Update References Through the APINext Where Recipient Categories Appear

Related Articles

  • Batch-Update References Through the API

    How an integration can send many create, read, update, and delete operations on reference records in a single API request, and how Rhythm reports the results.

  • Fees, Coupons, and Settings Through the API

    How application fees and coupons can be saved and batched through the API in ways the Console does not offer, and why you cannot check a batch against its rules without saving it.

On This Page

  • API Reference Documentation
  • Security
Rhythm Help Center© Rhythm Software

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

Browse Platform Documentation