Get User

GET /v1/auth/users/{user_id}
Authorization

Get a user with their various properties like emails, phone_numbers, and other attached identifiers.

HTTP Request

GET /v1/auth/users/{user_id}

Returns

A successful response returns a User object with linked identifiers such as emails, phone numbers in their corresponding properties.

Path parameters

  • user_id string Required

    Unique User ID of the user.

Responses

  • 200 application/json

    GetUserResp

    Hide response attributes Show response attributes object
    • user_id string Required

      Minimum length is 1.

    • first_name string Required

      Minimum length is 0.

    • middle_name string Required
    • last_name string Required

      Minimum length is 0.

    • active boolean Required
    • updated_at number Required
    • created_at number Required
    • emails array[object] Required

      At least 0 elements.

      Hide emails attributes Show emails attributes object
      • id string Required

        Minimum length is 1.

      • verified boolean Required
      • email string Required

        Minimum length is 1.

      • updated_at number Required
      • created_at number Required
    • phone_numbers array[object] Required

      At least 10 elements.

      Hide phone_numbers attributes Show phone_numbers attributes object
      • id string Required

        Minimum length is 1.

      • verified boolean Required
      • phone_number string Required

        Minimum length is 1.

      • updated_at number Required
      • created_at number Required
    • wallets array[object] Required

      At least 0 elements.

      Hide wallets attributes Show wallets attributes object
      • id string Required

        Minimum length is 1.

      • app_id string Required

        Minimum length is 1.

      • user_id string Required

        Minimum length is 1.

      • public_address string Required

        Minimum length is 1.

      • wallet_type string Required

        Minimum length is 1.

      • is_default boolean Required
      • updated_at number Required
      • created_at number Required
    • idp_providers array[object]

      At least 10 elements.

      Hide idp_providers attributes Show idp_providers attributes object
      • id string Required

        Minimum length is 1.

      • provider string Required

        Minimum length is 1.

      • provider_subject string Required

        Minimum length is 1.

      • idp_type string Required

        Minimum length is 1.

      • method_id string Required

        Minimum length is 1.

      • method_type string Required

        Minimum length is 1.

      • updated_at number Required
      • created_at number Required
    • totps array[object]

      At least 0 elements.

      Hide totps attributes Show totps attributes object
      • id string Required

        Minimum length is 1.

      • verified boolean Required
      • updated_at number Required
      • created_at number Required
GET /v1/auth/users/{user_id} 
curl \
 --request GET 'https://api.streambird.io/v1/auth/users/user_24wFP9pDa9YiMJLun94iKykoZs2' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "totps": [],
  "active": true,
  "emails": [
    {
      "id": "email_26AjWpEcss2YyqFh1san6Wjjs7o",
      "email": "hello@streambird.io",
      "verified": true,
      "created_at": 1646873318,
      "updated_at": 1646957196
    },
    {
      "id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7",
      "email": "sandbox@streambird.io",
      "verified": false,
      "created_at": 1642703333,
      "updated_at": 1642703333
    }
  ],
  "status": "active",
  "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
  "wallets": [
    {
      "id": "wallet_26AjWu075gRWMnjfPglcdoD2PAQ",
      "verified": true,
      "created_at": 1646873319,
      "is_default": true,
      "updated_at": 1646873319,
      "is_imported": false,
      "wallet_type": "ETH",
      "is_read_only": false,
      "public_address": "0x863c381a56a58370f435b0100faba94e6462b6d1"
    }
  ],
  "last_name": "",
  "created_at": 1646873318,
  "first_name": "",
  "updated_at": 1646873318,
  "middle_name": "",
  "idp_providers": [
    {
      "id": "idpuser_28SRho5nbD045LGq2btZWXhkdjN",
      "idp_type": "oauth",
      "provider": "google",
      "method_id": "email_26AjWpEcss2YyqFh1san6Wjjs7o",
      "created_at": 1651208121,
      "updated_at": 1651208121,
      "method_type": "email",
      "provider_subject": "100157402424066154830"
    }
  ],
  "phone_numbers": [
    {
      "id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
      "verified": false,
      "created_at": 1642703333,
      "updated_at": 1642703333,
      "phone_number": "+14152222222"
    }
  ],
  "webauthn_credentials": []
}