Loading ...

REST API: Get Users in Additional Recipient Roles | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Cases » REST API: Get Users in Additional Recipient Roles
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 20

REST API: Get Users in Additional Recipient Roles

0 
 /5
0 (0votes)
Open API Guide
GET/api/cases/projects/{projectid}/recipients

Returns a list of users who belong to the Additional Recipient Roles defined for a specific case project.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
projectIDIntegerYESPathThe ID of the project whose additional recipient users you want to retrieve

Optional Parameters

ParameterTypeRequiredLocationDescription
searchKeywordStringNOQuerySpecifies the search keyword
startPageIntegerNOQuerySpecifies the starting page index for the results. Default: 1.
pageLengthIntegerNOQuerySpecifies the number of records to return per page. Default: int.MaxValue.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/cases/projects/1272/recipients

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "AvatarImageURL": "https://your-site.com/Assets/Uploaded-Photos/1567/51f216e8-6412-41ea-81ac-a159f4a9e5e4.jpeg",
      "BlogID": 0,
      "DateJoined": "2026-01-01T12:00:00Z",
      "EmailRecieve": 3,
      "SpaceDigestOption": 0,
      "InvitationID": 0,
      "IsActivated": true,
      "IsAnonymous": false,
      "IsUserLocked": false,
      "IsBanned": false,
      "IsConfirmed": false,
      "IsContactInfoVisible": true,
      "IsFeatured": false,
      "IsIsolated": false,
      "IsProfileCompleted": false,
      "IsOptInPromotionalEmails": false,
      "IsPasswordEncrypted": false,
      "MediaServerID": 0,
      "MediaServerRootURL": "https://your-site.com/Assets/Uploaded-Photos",
      "MembershipStatus": 0,
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "PMNotification": false,
      "Points": 0,
      "ProfileURL": "https://your-site.com/people/Alice",
      "RankID": 0,
      "RoleID": 5,
      "ShowEmail": false,
      "UserID": 376,
      "UserInfoDisplayName": "Alice Romero",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "LastChatActivityDate": "2026-01-01T12:00:00Z",
      "UserPresenceStatus": 0,
      "IsPasswordHashed": false,
      "InOrgChart": false,
      "ConnectionStatus": 0,
      "CanChat": false,
      "CanBeConnectedInMSTeams": false,
      "MobileChatNotificationEnabled": false,
      "TenantID": 0
    },
    {
      "AvatarImageURL": "https://your-site.com/Assets/Uploaded-Photos/1543/6fdfa936-f17d-4005-81d9-7139540b6061.jpeg",
      "BlogID": 0,
      "DateJoined": "2026-01-01T12:00:00Z",
      "EmailRecieve": 3,
      "SpaceDigestOption": 0,
      "InvitationID": 0,
      "IsActivated": true,
      "IsAnonymous": false,
      "IsUserLocked": false,
      "IsBanned": false,
      "IsConfirmed": false,
      "IsContactInfoVisible": true,
      "IsFeatured": false,
      "IsIsolated": false,
      "IsProfileCompleted": false,
      "IsOptInPromotionalEmails": false,
      "IsPasswordEncrypted": false,
      "MediaServerID": 0,
      "MediaServerRootURL": "https://your-site.com/Assets/Uploaded-Photos",
      "MembershipStatus": 0,
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "PMNotification": false,
      "Points": 0,
      "ProfileURL": "https://your-site.com/people/Alexis",
      "RankID": 0,
      "RoleID": 5,
      "ShowEmail": false,
      "UserID": 376,
      "UserInfoDisplayName": "Alexis Fox",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "LastChatActivityDate": "2026-01-01T12:00:00Z",
      "UserPresenceStatus": 0,
      "IsPasswordHashed": false,
      "InOrgChart": false,
      "ConnectionStatus": 0,
      "CanChat": false,
      "CanBeConnectedInMSTeams": false,
      "MobileChatNotificationEnabled": false,
      "TenantID": 0
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (projectID)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.
404 Not FoundThe specified role was not found.Verify the roleID is correct.
500 Server ErrorInternal failure.Retry later.

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