---
title: "REST API: Get Space Users"
type: "wiki"
space: "Axero Documentation"
author: "Anonymous User"
created: 2019-01-10T06:08:16Z
updated: 2026-09-28T01:17:00Z
tags: ["API"]
url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/29968/rest-api-get-space-users"
---
# REST API: Get Space Users
[Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=29968)
GET/api/spaces/\{SpaceID\}/users
Get the members of a space, or with SpaceID 0 the site's users.
## Request
### Request Header
| Header | Required | Value | Description |
| :--- | :--- | :--- | :--- |
| `Authorization` | YES | `Bearer YOUR_TOKEN` | Bearer token for the authenticated user. [Learn how to create Bearer tokens](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens). |
### Required Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `SpaceID` | Integer | YES | Path | Unique identifier for a particular space. A value of 0 returns the site's users rather than a space's members. A value that is not a number is also read as 0, so a mistyped ID returns every user on the site with no error. Check the value before sending it. |
### Optional Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `SpaceUserMembershipStatus` | Integer | NO | Query | Membership status of the users to return: Pending approval = 0, Member = 1 \(default\), Non-member = 2. A value that is not a whole number is read as 1. |
| `RoleID` | Integer | NO | Query | Return only the members who hold this role in the space. A value that is not a whole number is ignored and every member is returned. |
| `UserID` | Integer | NO | Query | Accepted but has no effect: the list is not narrowed to this user. |
| `SearchKeyWord` | String | NO | Query | Text matched against the start of the username, first name, last name, email address, or full name. |
| `IsProfilePublic` | Boolean | NO | Query | true returns only users whose profile is public, and false only users whose profile is private. Any other value answers 500. |
| `StartPage` | Integer | NO | Query | Page of results to return. Default: 1. A value above 1 answers 500 unless PageLength is also sent. A value with a comma answers 500. |
| `PageLength` | Integer | NO | Query | Number of results to return per page. When omitted, or 0, every user is returned in one page. A value with a comma answers 500. |
| `Q` | String | NO | Query | Another name for SearchKeyWord. When sent, it replaces SearchKeyWord. The site's own people pickers send it. |
| `GetTokenInputFormatted` | Boolean | NO | Query | Default: false. When true, the response is a plain list of the matching users instead of the standard response with IsError, ResponseMessage, and ResponseData. Each user carries only id, name \(the display name\), and avatarimage. |
## 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": "Jane, Doe",
"MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
"NumBlogPosts": 0,
"NumPosts": 0,
"Occupation": "Product manager",
"PMNotification": false,
"Points": 925,
"ProfileImageURL": "https://your-site.com/Assets/Uploaded-Photos/1/avatar.jpg",
"ProfilePhoto": "avatar.jpg",
"ProfileURL": "https://your-site.com/people/jane.doe",
"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": 1,
"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": "alex.morgan@your-site.com",
"RenderedValues": [
"alex.morgan@your-site.com"
],
"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": "Jane",
"RenderedValues": [
"Jane"
],
"FieldUTCDates": [],
"LookupValues": [],
"FieldValues": [
"Jane"
],
"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": "Doe",
"RenderedValues": [
"Doe"
],
"FieldUTCDates": [],
"LookupValues": [],
"FieldValues": [
"Doe"
],
"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": "Product manager",
"RenderedValues": [
"Product manager"
],
"FieldUTCDates": [],
"LookupValues": [],
"FieldValues": [
"Product 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/1/avatar.jpg",
"RenderedValues": [
"https://your-site.com/Assets/Uploaded-Photos/1/avatar.jpg"
],
"FieldUTCDates": [],
"LookupValues": [],
"FieldValues": [
"avatar.jpg"
],
"FieldValue2": "https://your-site.com/Assets/Uploaded-Photos/1/avatar.jpg",
"FieldValues2": [
"https://your-site.com/Assets/Uploaded-Photos/1/avatar.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": "jane.doe",
"RenderedValues": [
"jane.doe"
],
"FieldUTCDates": [],
"LookupValues": [],
"FieldValues": [
"jane.doe"
],
"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": "403 Forbidden",
"ResponseData": []
}
```
## Error Handling
| Status Code | Likely Cause | Next Action |
| :--- | :--- | :--- |
| 400 Bad Request | Not returned: a value of the wrong type is ignored, or answers 500, as each parameter describes. | Check the query values. |
| 401 Unauthorized | Missing or invalid Bearer token on a site that only members can access. On a site open to guests, the call runs as a guest instead. | Check token validity. [Learn how to create Bearer tokens →](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens) |
| 403 Forbidden | This endpoint does not return 403: a caller who cannot view the space's members gets the 200 response described in the row below. | Confirm the user has the required roles for this action. |
| 500 Server Error | IsProfilePublic is not true or false, StartPage or PageLength holds a comma, or StartPage is above 1 without a PageLength. The response body is empty. | Retry later. |
| 200 with IsError | The 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.