Search Users | AISquare Studio

curl /api/v1/iam/search/ \
     -H "Content-Type: application/json"

{
  "id": 1024,
  "username": "jane.doe_92",
  "email": "jane.doe92@example.com",
  "first_time_login": false,
  "user_first_day": false,
  "details": [
    {
      "user_type": "developer",
      "skills_data": [
        {
          "id": 101,
          "name": "Python",
          "description": "Experienced in backend development and data science."
        }
      ],
      "investment_interests_data": [
        {
          "id": 5,
          "name": "Tech Startups",
          "description": "Interested in early-stage technology companies."
        }
      ],
      "technical_interests_data": [
        {
          "id": 202,
          "name": "Machine Learning",
          "description": "Focus on neural networks and deep learning."
        }
      ],
      "focus_area_data": [
        {
          "name": "Artificial Intelligence"
        }
      ],
      "top_domain_elo": 1520.75,
      "top_domain_rank": 42,
      "streak": "15",
      "highest_streak": "30",
      "streak_freeze_days": "2",
      "title": "Senior Developer",
      "unlocked_titles": "Contributor, Mentor",
      "followers_count": 350,
      "following_count": 180,
      "is_following": true,
      "is_followed_back": true,
      "profile_picture": "https://example.com/images/users/jane_doe.jpg",
      "bio": "Full-stack developer passionate about open source and AI.",
      "country": "USA",
      "phone": "+1-555-123-4567",
      "dob": "1992-04-15",
      "linkedin_url": "https://linkedin.com/in/janedoe",
      "github_url": "https://github.com/janedoe92",
      "twitter_url": "https://twitter.com/janedoe_dev",
      "facebook_url": "https://facebook.com/jane.doe.92",
      "website_url": "https://janedoe.dev",
      "portfolio_url": "https://portfolio.janedoe.dev",
      "resume": "https://janedoe.dev/resume.pdf",
      "communication_preferences_phone": true,
      "communication_preferences_email": true,
      "platform_features_emails": true,
      "activity_based_emails": false
    }
  ],
  "created_at": "2023-11-20T14:45:00Z",
  "full_name": "Jane Doe",
  "theme": "dark-mode",
  "login_count": 58,
  "refresh_count": 120,
  "referral_code": "REF12345XYZ",
  "referred_by": 987,
  "is_verified": true
}

Searches for users based on a query string.

Query parameters

qstringOptional

The search query string

Response

Search results

idintegerRead-only

usernamestringformat: "^[\w.@+-]+$"<=150 characters

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

emailstringformat: "email"<=254 characters

first_time_loginbooleanRead-only

Check if this is the user's first login.

user_first_daybooleanRead-only

Returns True if the user was created today, False otherwise

detailslist of objectsRead-only

created_atdatetimeRead-only

full_namestring<=150 characters

themestring or null<=255 characters

login_countinteger-2147483648-2147483647

refresh_countinteger-2147483648-2147483647

referral_codestring<=16 characters

referred_byinteger or null

is_verifiedboolean

Errors

401

Unauthorized Error

404

Not Found Error