Loading ...

REST API: Get User's Recognition Programs | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Recognition » REST API: Get User Recognition Programs
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Get User Recognition Programs

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

Enables administrators and developers to programmatically retrieve a list of recognition programs a user can participate in.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
ForUserIDIntegerYESQueryUser ID of the user to get a list of recognition programs for

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/recognition/awards/programs?ForUserID=641

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ContentID": 7089,
      "EntityType": 74,
      "ContentTypeID": 0,
      "ContentTitle": "Community Recognition Program",
      "ContentStub": "community-recognition-program",
      "ContentBody": "",
      "ContentSummary": "The Community Recognition Program rewards people who contribute most to the organization's culture and goals.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "ParentContentID": 0,
      "ContentVersionID": 0,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 0,
      "DateCreated": "2026-01-21T08:41:23.21",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0,
      "ContentFeaturedImageFullURL": "https://your-site.com/assets/Themes/default/images/photo-placeholder.gif",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "CategoryStub": "",
      "AuthorAvatarImageUrl": "https://your-site.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
      "AuthorProfileUrl": "https://your-site.com/people/admin",
      "TagsCSV": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "",
      "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,
      "ViewerVote": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "ParentContentStub": "",
      "GrandParentContentStub": "",
      "GreatGrandParentContentStub": "",
      "IsContentAvailablePostExpiry": false,
      "SystemName": "DefaultRecogntionProgram",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1
    },
    {
      "ContentID": 7142,
      "EntityType": 74,
      "ContentTypeID": 0,
      "ContentTitle": "Getting Started Program",
      "ContentStub": "getting-started-program",
      "ContentBody": "",
      "ContentSummary": "These Badges and Recognition are earned through activity challenges completed in our community site when you are getting started as a new member.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "ParentContentID": 0,
      "ContentVersionID": 0,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 0,
      "DateCreated": "2026-03-07T08:03:56.593",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0,
      "ContentFeaturedImageFullURL": "https://your-site.com/assets/Themes/default/images/photo-placeholder.gif",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 44,
      "CategoryStub": "",
      "AuthorAvatarImageUrl": "https://your-site.com/Assets/Uploaded-Photos/376/66cf48bb-c3df-441b-9ee7-0db833f7b41f.jpeg",
      "AuthorProfileUrl": "https://your-site.com/people/admin",
      "TagsCSV": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "",
      "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,
      "ViewerVote": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "ParentContentStub": "",
      "GrandParentContentStub": "",
      "GreatGrandParentContentStub": "",
      "IsContentAvailablePostExpiry": false,
      "SystemName": "",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1
    },
    {
      "ContentID": 12212,
      "EntityType": 74,
      "ContentTypeID": 0,
      "ContentTitle": "HR Recognition Program",
      "ContentStub": "hr-recognition-program",
      "ContentBody": "",
      "ContentSummary": "A recognition program for the HR department.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "ParentContentID": 0,
      "ContentVersionID": 0,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 0,
      "DateCreated": "2026-02-10T19:54:33.593",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0,
      "ContentFeaturedImageFullURL": "https://your-site.com/assets/Themes/default/images/photo-placeholder.gif",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 64,
      "CategoryStub": "",
      "AuthorAvatarImageUrl": "https://your-site.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
      "AuthorProfileUrl": "https://your-site.com/people/admin",
      "TagsCSV": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "",
      "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,
      "ViewerVote": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "ParentContentStub": "",
      "GrandParentContentStub": "",
      "GreatGrandParentContentStub": "",
      "IsContentAvailablePostExpiry": false,
      "SystemName": "",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1
    }
  ]
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (forUserID)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