Loading ...

REST API: Get User | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Get User
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 53

REST API: Get User

0 
 /5
0 (0votes)
Open API Guide
GET/api/users/{UserID}/details

Look up a user by their unique ID. This is the standard way to grab basic info for any community member. Use this when you have a UserID from another data source and need to show their name or profile picture quickly.

About the example response. The sample below shows some fields with a null value. The live API leaves those out of the response entirely rather than returning them as null, so code that expects every documented key to be present will not find them all. Read fields defensively, and treat a missing key and a null value as the same thing.

Request

Request Header

Header Required Value Description
Authorization YES Bearer YOUR_TOKEN Bearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

Parameter Type Required Location Description
UserID Integer YES Path Unique identifier for a particular user

Optional Parameters

Parameter Type Required Location Description
LogView Boolean NO Query Logs the API call as an action in User Activity when set to true

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/users/1311/details

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "AvatarImageURL": "https://your-site.com/Assets/Uploaded-Photos/1/avatar.jpg",
    "AvatarPath": "avatar.jpg",
    "Bio": "",
    "BlogID": 0,
    "DateBanned": "2026-09-05T04:10:13.13",
    "DateFormat": "MM/dd/yyyy",
    "DateJoined": "2026-09-05T04:01:43.007",
    "DateJoinedString": "12 minutes ago",
    "Description": "api-validate",
    "Email": "jane.doe@example.com",
    "EmailReceive": 3,
    "EmailRecieve": 3,
    "SpaceDigestOption": 0,
    "FirstName": "Jane",
    "Gender": 0,
    "CompanyName": "API Validate",
    "ICQIM": "API Validate",
    "IP": "64.226.136.48",
    "InvitationID": 0,
    "IsActivated": true,
    "IsAnonymous": false,
    "IsUserLocked": false,
    "IsBanned": false,
    "IsConfirmed": false,
    "IsContactInfoVisible": true,
    "IsFeatured": false,
    "IsIsolated": false,
    "IsProfileCompleted": true,
    "IsOptInPromotionalEmails": false,
    "IsPasswordEncrypted": true,
    "IsProfilePublic": true,
    "LastName": "Doe",
    "MediaServerID": 88,
    "MediaServerRootURL": "https://your-site.com/Assets/Uploaded-Photos",
    "MembershipStatus": 0,
    "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
    "MetaKeywords": "apivalidate20260905, ",
    "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
    "NumBlogPosts": 0,
    "NumPosts": 0,
    "PMNotification": false,
    "PhoneNumber": "5555550100",
    "Points": 100,
    "ProfileImageURL": "https://your-site.com/Assets/Uploaded-Photos/684/864bb20f-9208-423e-8d9b-633509e927e4.png",
    "ProfilePhoto": "864bb20f-9208-423e-8d9b-633509e927e4.png",
    "ProfileURL": "https://your-site.com/people/apivalidate20260905",
    "OnlineChatStatus": 1,
    "RankID": 1,
    "RankImage": "rank-lurker.gif",
    "RankImageURL": "https://your-site.com/Assets/Uploaded-Photos/rank-lurker.gif",
    "RankName": "Newbie",
    "RoleID": 0,
    "ShowEmail": true,
    "TimeFormat": "h:mm tt",
    "TimeZoneID": "Central Standard Time",
    "TimeZoneText": "(UTC-05:00) Central Daylight Time",
    "UserID": 684,
    "UserInfoDisplayName": "Api Validate",
    "UserName": "jane.doe",
    "HasJoinedViaThirdPartyLogin": false,
    "IsWindowsADUser": false,
    "ChatStatusCssClass": "status-offline",
    "ChatStatusText": "Offline",
    "LastChatActivityDate": "0001-01-01T00:00:00",
    "UserPresenceStatus": 3,
    "SimpleFields": {
      "9": {
        "FieldUseID": 9,
        "ContentTypeID": 15,
        "DataIDs": [
          9694
        ],
        "RenderedValue": "<a href='mailto:api-validate-2026-09-05@example.invalid' title='api-validate-2026-09-05@example.invalid'>api-validate-2026-09-05@example.invalid</a>",
        "RenderedValues": [
          "<a href='mailto:api-validate-2026-09-05@example.invalid' title='api-validate-2026-09-05@example.invalid'>api-validate-2026-09-05@example.invalid</a>"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "api-validate-2026-09-05@example.invalid"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "SystemName": "SystemEmail",
        "FieldType": 1,
        "FieldSubType": 2,
        "Visibility": 0,
        "TenantID": 0
      },
      "63": {
        "FieldUseID": 63,
        "ContentTypeID": 15,
        "DataIDs": [
          9695
        ],
        "RenderedValue": "Api",
        "RenderedValues": [
          "Api"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "Api"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": true,
        "IsPreference": false,
        "SystemName": "FirstName",
        "FieldType": 1,
        "FieldSubType": 1,
        "Visibility": 0,
        "TenantID": 0
      },
      "64": {
        "FieldUseID": 64,
        "ContentTypeID": 15,
        "DataIDs": [
          9696
        ],
        "RenderedValue": "Validate",
        "RenderedValues": [
          "Validate"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "Validate"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": true,
        "IsPreference": false,
        "SystemName": "LastName",
        "FieldType": 1,
        "FieldSubType": 1,
        "Visibility": 0,
        "TenantID": 0
      },
      "78": {
        "FieldUseID": 78,
        "ContentTypeID": 15,
        "DataIDs": [
          9706
        ],
        "RenderedValue": "API Validate",
        "RenderedValues": [
          "API Validate"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "API Validate"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": true,
        "IsPreference": false,
        "SystemName": "Company",
        "FieldType": 1,
        "FieldSubType": 1,
        "Visibility": 0,
        "TenantID": 0
      },
      "80": {
        "FieldUseID": 80,
        "ContentTypeID": 15,
        "DataIDs": [
          9708
        ],
        "RenderedValue": "<a href='tel:5555550100' title='5555550100'>5555550100</a>",
        "RenderedValues": [
          "<a href='tel:5555550100' title='5555550100'>5555550100</a>"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "5555550100"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "SystemName": "Phone",
        "FieldType": 1,
        "FieldSubType": 16,
        "Visibility": 0,
        "TenantID": 0
      },
      "92": {
        "FieldUseID": 92,
        "ContentTypeID": 15,
        "DataIDs": [
          9725
        ],
        "RenderedValue": "https://your-site.com/Assets/Uploaded-Photos/684/864bb20f-9208-423e-8d9b-633509e927e4.png",
        "RenderedValues": [
          "https://your-site.com/Assets/Uploaded-Photos/684/864bb20f-9208-423e-8d9b-633509e927e4.png"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "864bb20f-9208-423e-8d9b-633509e927e4.png"
        ],
        "FieldValue2": "https://your-site.com/Assets/Uploaded-Photos/684/f01c6f36-7975-420c-8c25-75c2caede889.png",
        "FieldValues2": [
          "https://your-site.com/Assets/Uploaded-Photos/684/f01c6f36-7975-420c-8c25-75c2caede889.png"
        ],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "SystemName": "ProfilePhoto",
        "FieldType": 12,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "99": {
        "FieldUseID": 99,
        "ContentTypeID": 15,
        "DataIDs": [
          0
        ],
        "RenderedValue": "",
        "RenderedValues": [
          ""
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          ""
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {
          "0": {}
        },
        "Indexed": false,
        "IsPreference": false,
        "SystemName": "Location",
        "FieldType": 14,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "110": {
        "FieldUseID": 110,
        "ContentTypeID": 15,
        "DataIDs": [
          9715
        ],
        "RenderedValue": "true",
        "RenderedValues": [
          "true"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "true"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "IsProfilePublic",
        "FieldType": 4,
        "FieldSubType": 6,
        "Visibility": 0,
        "TenantID": 0
      },
      "111": {
        "FieldUseID": 111,
        "ContentTypeID": 15,
        "DataIDs": [
          9716
        ],
        "RenderedValue": "true",
        "RenderedValues": [
          "true"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "true"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "IsContactInfoVisible",
        "FieldType": 4,
        "FieldSubType": 6,
        "Visibility": 0,
        "TenantID": 0
      },
      "112": {
        "FieldUseID": 112,
        "ContentTypeID": 15,
        "DataIDs": [
          9717
        ],
        "RenderedValue": "true",
        "RenderedValues": [
          "true"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "true"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "ShowEmail",
        "FieldType": 4,
        "FieldSubType": 6,
        "Visibility": 0,
        "TenantID": 0
      },
      "113": {
        "FieldUseID": 113,
        "ContentTypeID": 15,
        "DataIDs": [
          9718
        ],
        "RenderedValue": "daily,weekly",
        "RenderedValues": [
          "daily,weekly"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          ""
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "SpaceDigestOption",
        "FieldType": 7,
        "FieldSubType": 6,
        "Visibility": 0,
        "TenantID": 0
      },
      "114": {
        "FieldUseID": 114,
        "ContentTypeID": 15,
        "DataIDs": [
          9719
        ],
        "RenderedValue": "false",
        "RenderedValues": [
          "false"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "false"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "IsOptInPromotionalEmails",
        "FieldType": 4,
        "FieldSubType": 6,
        "Visibility": 0,
        "TenantID": 0
      },
      "115": {
        "FieldUseID": 115,
        "ContentTypeID": 15,
        "DataIDs": [
          9720
        ],
        "RenderedValue": "Central Standard Time",
        "RenderedValues": [
          "Central Standard Time"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "Central Standard Time"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "TimeZoneID",
        "FieldType": 7,
        "FieldSubType": 8,
        "Visibility": 0,
        "TenantID": 0
      },
      "116": {
        "FieldUseID": 116,
        "ContentTypeID": 15,
        "DataIDs": [
          9721
        ],
        "RenderedValue": "MM/dd/yyyy",
        "RenderedValues": [
          "MM/dd/yyyy"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "MM/dd/yyyy"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "DateFormat",
        "FieldType": 7,
        "FieldSubType": 8,
        "Visibility": 0,
        "TenantID": 0
      },
      "117": {
        "FieldUseID": 117,
        "ContentTypeID": 15,
        "DataIDs": [
          9722
        ],
        "RenderedValue": "h:mm tt",
        "RenderedValues": [
          "h:mm tt"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "h:mm tt"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "TimeFormat",
        "FieldType": 7,
        "FieldSubType": 8,
        "Visibility": 0,
        "TenantID": 0
      },
      "118": {
        "FieldUseID": 118,
        "ContentTypeID": 15,
        "DataIDs": [
          9723
        ],
        "RenderedValue": "true",
        "RenderedValues": [
          "true"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "true"
        ],
        "FieldValue2": "",
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": true,
        "SystemName": "EmailReceive",
        "FieldType": 4,
        "FieldSubType": 7,
        "Visibility": 0,
        "TenantID": 0
      },
      "129": {
        "FieldUseID": 129,
        "ContentTypeID": 15,
        "DataIDs": [
          0
        ],
        "RenderedValue": "https://your-site.com/Assets/Uploaded-Photos/9c300b47-cc86-44e3-aa9c-63e7ee23d541.jpg",
        "RenderedValues": [
          "https://your-site.com/Assets/Uploaded-Photos/9c300b47-cc86-44e3-aa9c-63e7ee23d541.jpg"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "9c300b47-cc86-44e3-aa9c-63e7ee23d541.jpg"
        ],
        "FieldValue2": "https://your-site.com/Assets/Uploaded-Photos/",
        "FieldValues2": [
          "https://your-site.com/Assets/Uploaded-Photos/"
        ],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": true,
        "IsPreference": false,
        "SystemName": "CoverPhoto",
        "FieldType": 12,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "106": {
        "FieldUseID": 106,
        "ContentTypeID": 0,
        "DataIDs": [
          0
        ],
        "RenderedValue": "apivalidate20260905",
        "RenderedValues": [
          "apivalidate20260905"
        ],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [
          "apivalidate20260905"
        ],
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "SystemName": "SystemUsername",
        "FieldType": 1,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "-21": {
        "FieldUseID": -21,
        "ContentTypeID": 0,
        "DataIDs": [],
        "RenderedValue": "",
        "RenderedValues": [],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [],
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "FieldType": 0,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "-22": {
        "FieldUseID": -22,
        "ContentTypeID": 15,
        "DataIDs": [],
        "RenderedValue": "",
        "RenderedValues": [],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [],
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "FieldType": 0,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "-25": {
        "FieldUseID": -25,
        "ContentTypeID": 15,
        "DataIDs": [],
        "RenderedValue": "",
        "RenderedValues": [],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [],
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "FieldType": 0,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "-23": {
        "FieldUseID": -23,
        "ContentTypeID": 15,
        "DataIDs": [],
        "RenderedValue": "",
        "RenderedValues": [],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [],
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "FieldType": 0,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      },
      "-24": {
        "FieldUseID": -24,
        "ContentTypeID": 15,
        "DataIDs": [],
        "RenderedValue": "",
        "RenderedValues": [],
        "FieldUTCDates": [],
        "LookupValues": [],
        "FieldValues": [],
        "FieldValues2": [],
        "OptionResourceKeys": [],
        "ChildFields": {},
        "Indexed": false,
        "IsPreference": false,
        "FieldType": 0,
        "FieldSubType": 0,
        "Visibility": 0,
        "TenantID": 0
      }
    },
    "IsPasswordHashed": true,
    "SupervisorID": 0,
    "DirectReportCount": 0,
    "InOrgChart": false,
    "ConnectionStatus": 0,
    "CanChat": false,
    "SpaceIDs": [
      291
    ],
    "RoleIDsTLC": [
      3
    ],
    "ContentMemberships": [
      1781
    ],
    "CanBeConnectedInMSTeams": false,
    "DirectReports": [],
    "ChatWith": 1,
    "MobileChatNotificationEnabled": true,
    "TenantID": 0
  }
}

Error Response

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

Notes

ProfileLastModified

The ProfileLastModified field is a UTC timestamp included in the response body. It represents the most recent update to any tracked profile field for that user.

To find every account changed inside a date range, use ProfileLastModifiedAfter and ProfileLastModifiedBefore on the user list endpoint, GET /api/users. They filter a list, so this endpoint, which returns one account, does not accept them. Both take dates in ISO 8601 format using UTC.

Examples:

  • Users modified after a date: /api/users?ProfileLastModifiedAfter=2025-03-15T14:30:00Z
  • Users modified before a date: /api/users?ProfileLastModifiedBefore=2025-04-01T00:00:00Z
  • Users modified within a range: /api/users?ProfileLastModifiedAfter=2025-03-01T00:00:00Z&ProfileLastModifiedBefore=2025-04-01T00:00:00Z

Configuration

The profile fields that trigger an update to the ProfileLastModified timestamp are controlled by a system property:

Property Location Description
ProfileLastModifiedTrackedFieldIds Control Panel > System > System Properties A comma-separated list of Field IDs to track. Supports system-defined fields (e.g., Email, Roles) and custom profile fields.

Tracking Behavior

  • When a user profile is saved and at least one tracked field changed, the ProfileLastModified timestamp is updated once, even if untracked fields also changed in the same operation.
  • If only untracked fields changed, the timestamp is not updated.
  • The timestamp is only updated for changes made after a field has been added to the tracked list. Previous modifications are not retroactively tracked.
  • Newly created custom profile fields are not tracked by default and must be manually added to the system property.
  • To disable tracking entirely, clear the ProfileLastModifiedTrackedFieldIds system property value.

Error Handling

Status Code Likely Cause Next Action
400 Bad Request UserID in the path is not an integer. Send the user's numeric ID.
401 Unauthorized Missing or invalid Bearer token. Check token validity. Learn how to create Bearer tokens →
403 Forbidden User does not have sufficient permissions. Confirm the user has the required roles for this action.
404 Not Found No user has that ID, or the account is not yet activated and the caller cannot administer users (the endpoint hides pending accounts); the response has no body. Verify the UserID.
500 Server Error Internal failure. Retry later.
200 with IsError The profile is private and the caller is neither a site administrator, the user, nor a confirmed connection (No permission). Call as a connection of the user or as a site administrator.

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