Loading ...

REST API: Get Connections | Axero Documentation

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

REST API: Get Connections

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

Get a list of connections of a particular user

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
UserIDIntegerYESPathID of the user whose friends need to be returned

Optional Parameters

ParameterTypeRequiredLocationDescription
IsConfirmedBooleanNOQuerySpecifies whether to return only confirmed friends
PageIntegerNOQuerySpecifies the starting page of list to be returned
PageLengthIntegerNOQuerySpecifies the number of results to be returned per page
LogViewBooleanNOQueryLogs 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/31/friends?IsConfirmed=true&Page=1&PageLength=10

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "AvatarImageURL": "your-site.com/Assets/Uploaded-Photos/10-b873e9f8-f062-413c-a386-cb680acdb4b5.png",
      "CreatedBy": 0,
      "Email": "SampleEmail@your-site.com",
      "FirstName": "Bob",
      "Gender": 0,
      "IsActivated": false,
      "IsAnonymous": false,
      "IsAvatarApproved": false,
      "IsBanned": false,
      "IsConfirmed": true,
      "IsContactInfoVisible": true,
      "IsFeatured": false,
      "IsIsolated": false,
      "IsProfileCompleted": false,
      "IsOptInPromotionalEmails": false,
      "IsProfilePublic": true,
      "LastName": "Harper",
      "MediaServerRootURL": "https:/your-site.com/Assets/Uploaded-Photos",
      "MembershipStatus": 0,
      "MembershipType": 0,
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "PMNotification": false,
      "Points": 79,
      "ProfileImageURL": "your-site.com/Assets/Uploaded-Photos/10-3aba367e-832a-4a44-8f19-d00c2471c45b.png",
      "ProfileURL": "your-site.com/people/member1",
      "RankID": 1,
      "RankImage": "rank-lurker.gif",
      "RankImageURL": "your-site.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "RankName": "Lurky",
      "RequestMessage": "",
      "RoleID": 5,
      "ShowEmail": false,
      "SpaceID": 252,
      "UserID": 376,
      "UserInfoDisplayName": "Bob Harper",
      "UserName": "bharper",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "FriendID": 0
    },
    {
      "AvatarImageURL": "your-site.com/Assets/Uploaded-Photos/10-b873e9f8-f062-413c-a386-cb680acdb4b5.png",
      "CreatedBy": 0,
      "Email": "SampleEmail@your-site.com",
      "FirstName": "Sandra",
      "Gender": 0,
      "IsActivated": false,
      "IsAnonymous": false,
      "IsAvatarApproved": false,
      "IsBanned": false,
      "IsConfirmed": true,
      "IsContactInfoVisible": true,
      "IsFeatured": false,
      "IsIsolated": false,
      "IsProfileCompleted": false,
      "IsOptInPromotionalEmails": false,
      "IsProfilePublic": true,
      "LastName": "Smith",
      "MediaServerRootURL": "https:/your-site.com/Assets/Uploaded-Photos",
      "MembershipStatus": 0,
      "MembershipType": 0,
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "PMNotification": false,
      "Points": 79,
      "ProfileImageURL": "your-site.com/Assets/Uploaded-Photos/10-3aba367e-832a-4a44-8f19-d00c2471c45b.png",
      "ProfileURL": "your-site.com/people/member1",
      "RankID": 1,
      "RankImage": "rank-lurker.gif",
      "RankImageURL": "your-site.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "RankName": "Lurky",
      "RequestMessage": "",
      "RoleID": 5,
      "ShowEmail": false,
      "SpaceID": 252,
      "UserID": 376,
      "UserInfoDisplayName": "Sandra Smith",
      "UserName": "ssmith",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "FriendID": 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. (userID)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 connection was not found.Verify the userID 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