Loading ...

REST API: Get Awards | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Recognition » REST API: Get Awards
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 25

REST API: Get Awards

0 
 /5
0 (0votes)
Open API Guide
GET/api/recognition/awards

Enables administrators and developers to programmatically retrieve a list of badges in a specific recognition program.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
ProgramIDIntegerYESQueryID of the recognition program

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/recognition/awards?ProgramID=1

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ContentID": 10,
      "EntityType": 74,
      "ContentTypeID": 74,
      "ContentTitle": "Creative Thinker",
      "ContentStub": "creative-thinker",
      "ContentBody": "<p>Thank you for your vision and insights! We appreciate the effort and time you put into your work. Your excellent work is an integral part of our company's success. We are thrilled to have you on our team!</p>",
      "ContentBodyUnprocessed": "<p>Thank you for your vision and insights! We appreciate the effort and time you put into your work. Your excellent work is an integral part of our company's success. We are thrilled to have you on our team!</p>",
      "ContentSummary": "Awarded to people who solve problems and get things done.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "Alexis Fox",
      "UpdatedByUserUsername": "admin",
      "UpdatedByUserEmail": "admin@email.com",
      "UpdatedByUserFirstName": "Alexis",
      "UpdatedByUserLastName": "Fox",
      "UpdatedByUserAvatarImageUrl": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "UpdatedByUserProfileUrl": "https://your-site.com/people/admin",
      "ParentContentID": 5,
      "ContentVersionID": 1,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2026-02-09T20:19:58.637",
      "DatePublished": "2026-02-09T20:19:58.637",
      "DateUpdated": "2026-02-09T20:19:58.637",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0,
      "MetaTitle": "Creative Thinker",
      "MetaDescription": "",
      "MetaKeywords": "",
      "ContentFeaturedImage": "CreativeThinker.png",
      "ContentThumbImage": "CreativeThinker.png",
      "ContentFeaturedImageFullURL": "https://your-site.com/Assets/Uploaded-Photos/CreativeThinker.png",
      "ContentThumbImageFullURL": "https://your-site.com/Assets/Uploaded-Photos/CreativeThinker.png",
      "PageH1Content": "",
      "HeadCustomContent": "",
      "SideBarContent": "",
      "ContentExternalID": "",
      "ExtraSideBarContent": "",
      "ExternalURL": "",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "ContentMediaServerRootURL": "https://your-site.com/Assets/Uploaded-CMS-Files",
      "AuthorDisplayName": "Alexis Fox",
      "AuthorEmail": "admin@email.com",
      "AuthorFirstName": "Alexis",
      "AuthorLastName": "Fox",
      "AuthorAvatarImageUrl": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "AuthorProfileUrl": "https://your-site.com/people/admin",
      "TagsCSV": "",
      "DateCreatedString": "23 hours ago",
      "DateCreatedShortString": "23 hours ago",
      "DatePublishedString": "23 hours ago",
      "DatePublishedShortString": "23 hours ago",
      "DateUpdatedString": "23 hours ago",
      "DateUpdatedShortString": "23 hours ago",
      "ContentURL": "/badges/10/creative-thinker",
      "ContentVersionURL": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "Community Recognition Program",
      "IsPublishedFromUnderProcessingMode": false,
      "IsBeingAddedViaExternalSource": false,
      "IsWallContent": false,
      "HasRead": false,
      "ContentTypeIconCSSClass": "icon-check-empty",
      "IsEditable": false,
      "IsWOPI": false,
      "IsDeletable": false,
      "IsDownloadable": false,
      "IsChekoutable": false,
      "IsUndochekoutable": false,
      "IsChekinable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": false,
      "IsMoveable": false,
      "IsChildContentCreationAllowed": false,
      "IsContentCreationAllowed": false,
      "ContentMediaOnlineViewUrl": "",
      "ContentMediaUrl": "",
      "ContentHistoryUrl": "",
      "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=10&vid=1','Google Docs',800,600)",
      "ViewerVote": 0,
      "VoteCount": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "TotalChildRecords": 0,
      "TotalGrandChildRecords": 0,
      "IsSticky": false,
      "IsAnswered": false,
      "ParentContentStub": "community-recognition-program",
      "AuthorRankImageUrl": "https://your-site.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "AuthorRankName": "Lurker",
      "IsContentAvailablePostExpiry": false,
      "ContentIDCode": "ylw3gZ8rcij9uXKQJWpo3w%3D%3D",
      "SystemName": "CreativeThinkerBadge",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "DateCreatedISOString": "2026-02-09T12:19:58.6370000",
      "DateCreatedFullString": "Tuesday, February 9, 2021 at 12:19 PM"
    },
    {
      "ContentID": 9,
      "EntityType": 74,
      "ContentTypeID": 74,
      "ContentTitle": "Great Job",
      "ContentStub": "great-job",
      "ContentBody": "<p>Great job! We appreciate you for stepping up and taking initiative. Your skills, work ethic, and professionalism are a great benefit to our company. Thanks for setting a great example for others. Keep up the great work!</p>",
      "ContentBodyUnprocessed": "<p>Great job! We appreciate you for stepping up and taking initiative. Your skills, work ethic, and professionalism are a great benefit to our company. Thanks for setting a great example for others. Keep up the great work!</p>",
      "ContentSummary": "Awarded to people who go above and beyond.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "Alexis Fox",
      "UpdatedByUserUsername": "admin",
      "UpdatedByUserEmail": "admin@email.com",
      "UpdatedByUserFirstName": "Alexis",
      "UpdatedByUserLastName": "Fox",
      "UpdatedByUserAvatarImageUrl": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "UpdatedByUserProfileUrl": "https://your-site.com/people/admin",
      "ParentContentID": 5,
      "ContentVersionID": 1,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2026-02-09T20:19:58.637",
      "DatePublished": "2026-02-09T20:19:58.637",
      "DateUpdated": "2026-02-09T20:19:58.637",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0,
      "MetaTitle": "Great Job",
      "MetaDescription": "",
      "MetaKeywords": "",
      "ContentFeaturedImage": "GreatJob.png",
      "ContentThumbImage": "GreatJob.png",
      "ContentFeaturedImageFullURL": "https://your-site.com/Assets/Uploaded-Photos/GreatJob.png",
      "ContentThumbImageFullURL": "https://your-site.com/Assets/Uploaded-Photos/GreatJob.png",
      "PageH1Content": "",
      "HeadCustomContent": "",
      "SideBarContent": "",
      "ContentExternalID": "",
      "ExtraSideBarContent": "",
      "ExternalURL": "",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "ContentMediaServerRootURL": "https://your-site.com/Assets/Uploaded-CMS-Files",
      "AuthorDisplayName": "Alexis Fox",
      "AuthorEmail": "admin@email.com",
      "AuthorFirstName": "Alexis",
      "AuthorLastName": "Fox",
      "AuthorAvatarImageUrl": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "AuthorProfileUrl": "https://your-site.com/people/admin",
      "TagsCSV": "",
      "DateCreatedString": "23 hours ago",
      "DateCreatedShortString": "23 hours ago",
      "DatePublishedString": "23 hours ago",
      "DatePublishedShortString": "23 hours ago",
      "DateUpdatedString": "23 hours ago",
      "DateUpdatedShortString": "23 hours ago",
      "ContentURL": "/badges/9/great-job",
      "ContentVersionURL": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "Community Recognition Program",
      "IsPublishedFromUnderProcessingMode": false,
      "IsBeingAddedViaExternalSource": false,
      "IsWallContent": false,
      "HasRead": false,
      "ContentTypeIconCSSClass": "icon-check-empty",
      "IsEditable": false,
      "IsWOPI": false,
      "IsDeletable": false,
      "IsDownloadable": false,
      "IsChekoutable": false,
      "IsUndochekoutable": false,
      "IsChekinable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": false,
      "IsMoveable": false,
      "IsChildContentCreationAllowed": false,
      "IsContentCreationAllowed": false,
      "ContentMediaOnlineViewUrl": "",
      "ContentMediaUrl": "",
      "ContentHistoryUrl": "",
      "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=9&vid=1','Google Docs',800,600)",
      "ViewerVote": 0,
      "VoteCount": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "TotalChildRecords": 0,
      "TotalGrandChildRecords": 0,
      "IsSticky": false,
      "IsAnswered": false,
      "ParentContentStub": "community-recognition-program",
      "AuthorRankImageUrl": "https://your-site.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "AuthorRankName": "Lurker",
      "IsContentAvailablePostExpiry": false,
      "ContentIDCode": "R1Bex5Fmk3WMtSyMK0TlMg%3D%3D",
      "SystemName": "GreatJobBadge",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "DateCreatedISOString": "2026-02-09T12:19:58.6370000",
      "DateCreatedFullString": "Tuesday, February 9, 2021 at 12:19 PM"
    },
    {
      "ContentID": 8,
      "EntityType": 74,
      "ContentTypeID": 74,
      "ContentTitle": "Innovation",
      "ContentStub": "innovation",
      "ContentBody": "<p>Your work is outstanding! Your ability to create and implement solutions for our customer's needs adds significant value to our company and brand. Your vision and skills are invaluable to our organization. Keep up the great work!</p>",
      "ContentBodyUnprocessed": "<p>Your work is outstanding! Your ability to create and implement solutions for our customer's needs adds significant value to our company and brand. Your vision and skills are invaluable to our organization. Keep up the great work!</p>",
      "ContentSummary": "Awarded to people who demonstrate brilliant thinking.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "Alexis Fox",
      "UpdatedByUserUsername": "admin",
      "UpdatedByUserEmail": "admin@email.com",
      "UpdatedByUserFirstName": "Alexis",
      "UpdatedByUserLastName": "Fox",
      "UpdatedByUserAvatarImageUrl": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "UpdatedByUserProfileUrl": "https://your-site.com/people/admin",
      "ParentContentID": 5,
      "ContentVersionID": 1,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2026-02-09T20:19:58.637",
      "DatePublished": "2026-02-09T20:19:58.637",
      "DateUpdated": "2026-02-09T20:19:58.637",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0,
      "MetaTitle": "Innovation",
      "MetaDescription": "",
      "MetaKeywords": "",
      "ContentFeaturedImage": "Innovation.png",
      "ContentThumbImage": "Innovation.png",
      "ContentFeaturedImageFullURL": "https://your-site.com/Assets/Uploaded-Photos/Innovation.png",
      "ContentThumbImageFullURL": "https://your-site.com/Assets/Uploaded-Photos/Innovation.png",
      "PageH1Content": "",
      "HeadCustomContent": "",
      "SideBarContent": "",
      "ContentExternalID": "",
      "ExtraSideBarContent": "",
      "ExternalURL": "",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "ContentMediaServerRootURL": "https://your-site.com/Assets/Uploaded-CMS-Files",
      "AuthorDisplayName": "Alexis Fox",
      "AuthorEmail": "admin@email.com",
      "AuthorFirstName": "Alexis",
      "AuthorLastName": "Fox",
      "AuthorAvatarImageUrl": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "AuthorProfileUrl": "https://your-site.com/people/admin",
      "TagsCSV": "",
      "DateCreatedString": "23 hours ago",
      "DateCreatedShortString": "23 hours ago",
      "DatePublishedString": "23 hours ago",
      "DatePublishedShortString": "23 hours ago",
      "DateUpdatedString": "23 hours ago",
      "DateUpdatedShortString": "23 hours ago",
      "ContentURL": "/badges/8/innovation",
      "ContentVersionURL": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "Community Recognition Program",
      "IsPublishedFromUnderProcessingMode": false,
      "IsBeingAddedViaExternalSource": false,
      "IsWallContent": false,
      "HasRead": false,
      "ContentTypeIconCSSClass": "icon-check-empty",
      "IsEditable": false,
      "IsWOPI": false,
      "IsDeletable": false,
      "IsDownloadable": false,
      "IsChekoutable": false,
      "IsUndochekoutable": false,
      "IsChekinable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": false,
      "IsMoveable": false,
      "IsChildContentCreationAllowed": false,
      "IsContentCreationAllowed": false,
      "ContentMediaOnlineViewUrl": "",
      "ContentMediaUrl": "",
      "ContentHistoryUrl": "",
      "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=8&vid=1','Google Docs',800,600)",
      "ViewerVote": 0,
      "VoteCount": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "TotalChildRecords": 0,
      "TotalGrandChildRecords": 0,
      "IsSticky": false,
      "IsAnswered": false,
      "ParentContentStub": "community-recognition-program",
      "AuthorRankImageUrl": "https://your-site.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "AuthorRankName": "Lurker",
      "IsContentAvailablePostExpiry": false,
      "ContentIDCode": "hcaf187hT77scprlnRXuOQ%3D%3D",
      "SystemName": "InnovationBadge",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "DateCreatedISOString": "2026-02-09T12:19:58.6370000",
      "DateCreatedFullString": "Tuesday, February 9, 2021 at 12:19 PM"
    }
  ]
}

Error Response

{
  "Message": "No HTTP resource was found that matches the request URI 'https://your-site.com/api/recognition/awards'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (programID)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
404 or 405A required query parameter was left out, so the request matched a different action or none: the message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter; the message is not about the resource.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages