Loading ...

REST API: Get Users for Persona | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Personas » REST API: Get Users for Persona
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 27

REST API: Get Users for Persona

0 
 /5
0 (0votes)
Open API Guide
GET/api/personas/{PersonaID}/users

Returns the users who match a persona's conditions, a page at a time, with the total number of matches.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
PersonaIDIntegerYESPathUnique identifier for a specific Persona

Optional Parameters

ParameterTypeRequiredLocationDescription
PageLengthIntegerNOQueryNumber of users to return per page. Defaults to 20. 0 returns no users; a value that is not a number is read as 20.
StartPageIntegerNOQueryPage of results to return. Defaults to 1. A value that is not a number is read as 1.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/personas/1/users

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "TotalUsersCount": 1,
    "Users": [
      {
        "Title": "Jane Doe",
        "Summary": "Engineer",
        "IsIsolated": false,
        "WallPostToUserID": 0,
        "DateCreated": "0001-01-01T00:00:00",
        "DatePublished": "0001-01-01T00:00:00",
        "DateUpdated": "0001-01-01T00:00:00",
        "ShowDate": true,
        "ShowMetaData": true,
        "AuthorUserID": 0,
        "SpaceID": 0,
        "ContentStatusID": 0,
        "ContentCurrentWorkFlowStepID": 0,
        "EntityType": 0,
        "ContentID": 42,
        "ContentURL": "https://your-site.com/people/jane.doe",
        "ContentImageURL": "https://your-site.com/Assets/Uploaded-Photos/42/avatar.jpg",
        "ContentMediaServerID": 0,
        "WallID": 0,
        "GreatGrandParentContentID": 0,
        "IsPromoted": false,
        "ForumPostForumID": 0,
        "ForumPostTopicID": 0,
        "IsExternalContent": false,
        "ParentEntityType": 0,
        "ParentContentID": 0,
        "UserIsProfilePublic": false,
        "UserIsActivated": false,
        "CommentCount": 0,
        "LikeCount": 0,
        "PageViews": 0,
        "Rating": 0.0,
        "IsComment": false,
        "IsSpaceLevel": false,
        "IsFeatured": false,
        "IsLatest": false,
        "IsContentPubliclyAccessible": false,
        "IsAddedFromActivityStream": false,
        "ShowRating": false,
        "ShowViewCount": false,
        "ShowCommentCount": false,
        "EventStartDate": "0001-01-01T00:00:00",
        "IsRecurringTime": false,
        "IsRepeat": false,
        "EventEndDate": "0001-01-01T00:00:00",
        "EventScheduleStartDate": "0001-01-01T00:00:00",
        "EventScheduleEndDate": "0001-01-01T00:00:00",
        "EventCountryID": 0,
        "EventStateID": 0,
        "EventMetroID": 0,
        "EventIsAllDay": false,
        "EventIsPrivate": false,
        "EventTypeID": 0,
        "SpaceVisibility": 0,
        "TotalChildRecords": 0,
        "IsAwardPost": false,
        "AwardID": 0,
        "MembershipContentID": 0,
        "ConnectedToUser": false,
        "IssueCommentIsProjectActive": false,
        "IssueCommentIsInternal": false,
        "IssueCommentIssueID": 0,
        "ActivityActionEnum": 0,
        "ActivityLogBrowserType": 0,
        "ActivityLogOperatingSys": 0,
        "ActivityLogUserID": 0,
        "IndexedContentType": 0,
        "IsRequiredReading": false,
        "IsRequiredReadingConfirmed": false,
        "IsAnonymous": false
      }
    ],
    "TenantID": 0
  }
}

In each Users entry, ContentID is the user's ID and Title is the user's display name. To match people against another list, compare ContentID.

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestPersonaID in the path is not an integer.Send the persona's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe persona does not exist, or the caller cannot view it. Any signed-in caller can read a persona unless its Private switch is on. A private persona is returned only to a caller who can manage site personas, or who can manage space personas when the persona's only Add to space action names one space.Check the PersonaID, the persona's Private switch, and the caller's rights to manage personas.
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