REST API: Get Getting Started Steps Status | Axero Documentation

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/users/all/profilecomplete/status

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "UserID": 376,
      "UserInfoDisplayName": "Alexis Fox",
      "StepWeightageProgressCompleted": 100,
      "Completed": "Add profile photo, Set your preferences, Complete your profile, Join a space",
      "NotCompleted": "Invite people"
    },
    {
      "UserID": 376,
      "UserInfoDisplayName": "Alexis Test",
      "StepWeightageProgressCompleted": 0,
      "Completed": "",
      "NotCompleted": "Add profile photo, Set your preferences, Complete your profile, Join a space"
    },
    {
      "UserID": 376,
      "UserInfoDisplayName": "Alice Romero",
      "StepWeightageProgressCompleted": 75,
      "Completed": "Add profile photo, Complete your profile, Join a space",
      "NotCompleted": "Set your preferences"
    },
    {
      "UserID": 376,
      "UserInfoDisplayName": "Antonia Murray",
      "StepWeightageProgressCompleted": 50,
      "Completed": "Add profile photo, Join a space",
      "NotCompleted": "Set your preferences, Complete your profile"
    },
    {
      "UserID": 376,
      "UserInfoDisplayName": "Axero Support",
      "StepWeightageProgressCompleted": 75,
      "Completed": "Add profile photo, Complete your profile, Join a space",
      "NotCompleted": "Invite people, Set your preferences"
    },
    {
      "UserID": 376,
      "UserInfoDisplayName": "Ben Newman",
      "StepWeightageProgressCompleted": 50,
      "Completed": "Add profile photo, Join a space",
      "NotCompleted": "Set your preferences, Complete your profile"
    },
    {
      "UserID": 376,
      "UserInfoDisplayName": "Brett Barrington",
      "StepWeightageProgressCompleted": 50,
      "Completed": "Add profile photo, Join a space",
      "NotCompleted": "Set your preferences, Complete your profile"
    }
  ]
}

Error Response

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

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.