Every Awards API endpoint, grouped by what it works on. Organization- and event-level endpoints sit side by side, with the scope each one needs.
Awards workspace
| Endpoint | Level | Needs |
|---|
GET Get the Awards workspace home/v1/organization/{orgId}/awards/workspace | Organization | read:awards |
GET Get the setup answers/v1/organization/{orgId}/awards/workspace/profile | Organization | read:awards |
PUT Update the setup answers/v1/organization/{orgId}/awards/workspace/profile | Organization | write:awards |
GET List what Enterprise Awards adds/v1/organization/{orgId}/awards/workspace/enterprise | Organization | read:awards |
GET Get awards results/v1/organization/{orgId}/awards/workspace/results | Organization | read:awards |
Workspace programs
| Endpoint | Level | Needs |
|---|
GET List awards programs/v1/organization/{orgId}/awards/workspace/programs | Organization | read:awards |
POST Create a draft awards program/v1/organization/{orgId}/awards/workspace/programs | Organization | write:awards |
GET Get an awards program/v1/organization/{orgId}/awards/workspace/programs/{programId} | Organization | read:awards |
PUT Update an awards program/v1/organization/{orgId}/awards/workspace/programs/{programId} | Organization | write:awards |
PUT Replace a program's scorecard/v1/organization/{orgId}/awards/workspace/programs/{programId}/scorecard | Organization | write:awards |
PUT Replace a program's categories/v1/organization/{orgId}/awards/workspace/programs/{programId}/categories | Organization | write:awards |
POST Ask to open nominations/v1/organization/{orgId}/awards/workspace/programs/{programId}/open | Organization | write:awards |
POST Close nominations/v1/organization/{orgId}/awards/workspace/programs/{programId}/close | Organization | write:awards |
Workspace review and winners
| Endpoint | Level | Needs |
|---|
GET Get review progress/v1/organization/{orgId}/awards/workspace/programs/{programId}/review | Organization | read:awards |
POST Ask to invite Reviewers/v1/organization/{orgId}/awards/workspace/programs/{programId}/reviewers | Organization | write:awards |
POST Assign Reviewers to nominations/v1/organization/{orgId}/awards/workspace/programs/{programId}/assign | Organization | write:awards |
POST Summarize the reviews of a nomination/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary | Organization | read:awards |
GET Preview the winner announcement/v1/organization/{orgId}/awards/workspace/programs/{programId}/announce/preview | Organization | read:awards |
POST Ask to announce the winners/v1/organization/{orgId}/awards/workspace/programs/{programId}/announce | Organization | write:awards |
POST Remind reviewers or unfinished nominators/v1/organization/{orgId}/awards/workspace/programs/{programId}/remind | Organization | write:awards |
GET Get a reminder's progress/v1/organization/{orgId}/awards/workspace/programs/{programId}/reminders/{reminderId} | Organization | read:awards |
Sites
| Endpoint | Level | Needs |
|---|
GET List Sites/v1/organization/{orgId}/sites | Organization | — |
POST Make a Site/v1/organization/{orgId}/sites/make | Organization | — |
GET Get a Site/v1/organization/{orgId}/sites/{siteId} | Organization | — |
PUT Edit a Site's draft/v1/organization/{orgId}/sites/{siteId}/draft | Organization | — |
GET See what Publish would change/v1/organization/{orgId}/sites/{siteId}/diff | Organization | — |
GET Preview a Site as a role on a device/v1/organization/{orgId}/sites/{siteId}/preview | Organization | — |
POST Publish a Site/v1/organization/{orgId}/sites/{siteId}/publish | Organization | — |
POST Discard a Site's draft/v1/organization/{orgId}/sites/{siteId}/draft/discard | Organization | — |
GET List a Site's versions/v1/organization/{orgId}/sites/{siteId}/versions | Organization | — |
POST Restore a version into the draft/v1/organization/{orgId}/sites/{siteId}/versions/{versionId}/restore | Organization | — |