Loading ...

REST API: Get Space Users | Axero Documentation

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

REST API: Get Space Users

0 
 /5
0 (0votes)
Open API Guide
GET/api/spaces/{SpaceID}/users

Get the members of a space, or with SpaceID 0 the site's users.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESPathUnique identifier for a particular space

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceUserMembershipStatusIntegerNOQueryMembership status of the users to return: Pending approval = 0, Member = 1 (default), Non-member = 2.
RoleIDIntegerNOQuerySpecifies the role id of the role the space user have in the space
UserIDIntegerNOQuerySpecifies the user id of the space user
SearchKeyWordStringNOQueryText to search the users by (name, username, or email).
IsProfilePublicBooleanNOQuerySpecifies profile visibility of the user
StartPageIntegerNOQueryPage of results to return. Default: 1.
PageLengthIntegerNOQueryNumber of results to return per page. When omitted, or 0, every user is returned in one page.
QStringNOQueryAlias of SearchKeyWord. When sent it replaces SearchKeyWord; token-input pickers send it.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/3/users

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "AvatarImageURL": "https://your-site.com/Assets/Uploaded-Photos/1/avatar.jpg",
      "AvatarPath": "avatar.jpg",
      "BlogID": 0,
      "DOB": "2000-05-14T00:00:00",
      "DateFormat": "M/d/yyyy",
      "DateJoined": "2024-04-07T20:02:13.427",
      "DateJoinedString": "7 minutes ago",
      "DateLastVisited": "2026-09-04T01:20:13.6",
      "DateLastVisitedString": "yesterday",
      "Email": "jane.doe@example.com",
      "EmailReceive": 3,
      "EmailRecieve": 3,
      "SpaceDigestOption": 0,
      "FirstName": "Jane",
      "Gender": 0,
      "CompanyName": "Axero",
      "ICQIM": "Axero",
      "IP": "",
      "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": 1,
      "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
      "MetaKeywords": "Maxwell, Drain",
      "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "Occupation": "Technical Support Manager",
      "PMNotification": false,
      "Points": 925,
      "ProfileImageURL": "https://your-site.com/Assets/Uploaded-Photos/630/ac592329-fa36-486c-917d-30016b040226.jpg",
      "ProfilePhoto": "ac592329-fa36-486c-917d-30016b040226.jpg",
      "ProfileURL": "https://your-site.com/people/maxwell",
      "OnlineChatStatus": 1,
      "RankID": 2,
      "RankImage": "rank-starter.gif",
      "RankImageURL": "https://your-site.com/Assets/Uploaded-Photos/rank-starter.gif",
      "RankName": "Starter",
      "RoleID": 0,
      "ShowEmail": true,
      "TimeFormat": "h:mm tt",
      "TimeZoneID": "Eastern Standard Time",
      "TimeZoneText": "(UTC-04:00) Eastern Daylight Time",
      "UserID": 630,
      "UserInfoDisplayName": "Alex Morgan",
      "UserName": "jane.doe",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "ChatStatusCssClass": "status-offline",
      "ChatStatusText": "Offline",
      "LastChatActivityDate": "2026-09-03T21:58:53.317",
      "UserPresenceStatus": 3,
      "SimpleFields": {
        "9": {
          "FieldUseID": 9,
          "ContentTypeID": 15,
          "DataIDs": [
            8432
          ],
          "RenderedValue": "<a href='mailto:alex.morgan@your-site.com' title='alex.morgan@your-site.com'>alex.morgan@your-site.com</a>",
          "RenderedValues": [
            "<a href='mailto:alex.morgan@your-site.com' title='alex.morgan@your-site.com'>alex.morgan@your-site.com</a>"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "alex.morgan@your-site.com"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "SystemEmail",
          "FieldType": 1,
          "FieldSubType": 2,
          "Visibility": 0,
          "TenantID": 0
        },
        "63": {
          "FieldUseID": 63,
          "ContentTypeID": 15,
          "DataIDs": [
            8433
          ],
          "RenderedValue": "Maxwell",
          "RenderedValues": [
            "Maxwell"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Maxwell"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "FirstName",
          "FieldType": 1,
          "FieldSubType": 1,
          "Visibility": 0,
          "TenantID": 0
        },
        "64": {
          "FieldUseID": 64,
          "ContentTypeID": 15,
          "DataIDs": [
            8434
          ],
          "RenderedValue": "Drain",
          "RenderedValues": [
            "Drain"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Drain"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "LastName",
          "FieldType": 1,
          "FieldSubType": 1,
          "Visibility": 0,
          "TenantID": 0
        },
        "68": {
          "FieldUseID": 68,
          "ContentTypeID": 15,
          "DataIDs": [
            9235
          ],
          "RenderedValue": "05/14/2000",
          "RenderedValues": [
            "05/14/2000"
          ],
          "FieldUTCDate": "2000-05-14T00:00:00",
          "FieldUTCDates": [
            "2000-05-14T00:00:00"
          ],
          "LookupValues": [],
          "FieldValues": [
            "2000-05-14T00:00:00.00"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "DOB",
          "FieldType": 8,
          "FieldSubType": 10,
          "Visibility": 0,
          "TenantID": 0
        },
        "78": {
          "FieldUseID": 78,
          "ContentTypeID": 15,
          "DataIDs": [
            8440
          ],
          "RenderedValue": "Axero",
          "RenderedValues": [
            "Axero"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Axero"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "Company",
          "FieldType": 1,
          "FieldSubType": 1,
          "Visibility": 0,
          "TenantID": 0
        },
        "79": {
          "FieldUseID": 79,
          "ContentTypeID": 15,
          "DataIDs": [
            8441
          ],
          "RenderedValue": "Technical Support Manager",
          "RenderedValues": [
            "Technical Support Manager"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Technical Support Manager"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "Title",
          "FieldType": 1,
          "FieldSubType": 1,
          "Visibility": 0,
          "TenantID": 0
        },
        "92": {
          "FieldUseID": 92,
          "ContentTypeID": 15,
          "DataIDs": [
            8442
          ],
          "RenderedValue": "https://your-site.com/Assets/Uploaded-Photos/630/ac592329-fa36-486c-917d-30016b040226.jpg",
          "RenderedValues": [
            "https://your-site.com/Assets/Uploaded-Photos/630/ac592329-fa36-486c-917d-30016b040226.jpg"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "ac592329-fa36-486c-917d-30016b040226.jpg"
          ],
          "FieldValue2": "https://your-site.com/Assets/Uploaded-Photos/630/3c002416-1364-4228-b815-9019d520aded.jpg",
          "FieldValues2": [
            "https://your-site.com/Assets/Uploaded-Photos/630/3c002416-1364-4228-b815-9019d520aded.jpg"
          ],
          "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": [
            8435
          ],
          "RenderedValue": "true",
          "RenderedValues": [
            "true"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "true"
          ],
          "FieldValue2": "false",
          "FieldValues2": [
            "false"
          ],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": true,
          "SystemName": "IsProfilePublic",
          "FieldType": 4,
          "FieldSubType": 6,
          "Visibility": 0,
          "TenantID": 0
        },
        "111": {
          "FieldUseID": 111,
          "ContentTypeID": 15,
          "DataIDs": [
            8436
          ],
          "RenderedValue": "true",
          "RenderedValues": [
            "true"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "true"
          ],
          "FieldValue2": "false",
          "FieldValues2": [
            "false"
          ],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": true,
          "SystemName": "IsContactInfoVisible",
          "FieldType": 4,
          "FieldSubType": 6,
          "Visibility": 0,
          "TenantID": 0
        },
        "112": {
          "FieldUseID": 112,
          "ContentTypeID": 15,
          "DataIDs": [
            8437
          ],
          "RenderedValue": "true",
          "RenderedValues": [
            "true"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "true"
          ],
          "FieldValue2": "false",
          "FieldValues2": [
            "false"
          ],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": true,
          "SystemName": "ShowEmail",
          "FieldType": 4,
          "FieldSubType": 6,
          "Visibility": 0,
          "TenantID": 0
        },
        "113": {
          "FieldUseID": 113,
          "ContentTypeID": 15,
          "DataIDs": [
            8438
          ],
          "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
        },
        "115": {
          "FieldUseID": 115,
          "ContentTypeID": 15,
          "DataIDs": [
            8722
          ],
          "RenderedValue": "Eastern Standard Time",
          "RenderedValues": [
            "Eastern Standard Time"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Eastern Standard Time"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": true,
          "SystemName": "TimeZoneID",
          "FieldType": 7,
          "FieldSubType": 8,
          "Visibility": 0,
          "TenantID": 0
        },
        "118": {
          "FieldUseID": 118,
          "ContentTypeID": 15,
          "DataIDs": [
            8439
          ],
          "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": [
            8443
          ],
          "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
        },
        "190": {
          "FieldUseID": 190,
          "ContentTypeID": 15,
          "DataIDs": [
            8759
          ],
          "RenderedValue": "TSE",
          "RenderedValues": [
            "TSE"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "TSE"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "",
          "FieldType": 1,
          "FieldSubType": 1,
          "Visibility": 0,
          "TenantID": 0
        },
        "194": {
          "FieldUseID": 194,
          "ContentTypeID": 15,
          "DataIDs": [
            8683
          ],
          "RenderedValue": "Everyone",
          "RenderedValues": [
            "Everyone"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Everyone"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "",
          "FieldType": 1,
          "FieldSubType": 1,
          "Visibility": 0,
          "TenantID": 0
        },
        "195": {
          "FieldUseID": 195,
          "ContentTypeID": 15,
          "DataIDs": [
            8684
          ],
          "RenderedValue": "3774",
          "RenderedValues": [
            "3774"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "3774"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "",
          "FieldType": 1,
          "FieldSubType": 1,
          "Visibility": 0,
          "TenantID": 0
        },
        "106": {
          "FieldUseID": 106,
          "ContentTypeID": 0,
          "DataIDs": [
            0
          ],
          "RenderedValue": "maxwell",
          "RenderedValues": [
            "maxwell"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "maxwell"
          ],
          "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": 4,
      "CanChat": false,
      "SpaceIDs": [
        252
      ],
      "RoleIDsTLC": [
        1
      ],
      "ContentMemberships": [
        1781
      ],
      "CanBeConnectedInMSTeams": false,
      "DirectReports": [],
      "ChatWith": 1,
      "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 RequestA value is not of the documented type.Check the query values.
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.
200 with IsErrorThe caller cannot view the space's members: ResponseMessage carries the 403 Forbidden message and ResponseData is an empty list.Check the caller's rights on the space.

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