Get user

GET /v1/client/user

Returns information and identifier of the requesting user

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • app_id integer Required
      • uid string Required
      • user_id integer(int64) Required
      • username string
      • email string(email)
      • terms_of_service_version integer
      • privacy_policy_version integer
      • custom_fields array[object] Required
        Hide custom_fields attributes Show custom_fields attributes object
        • id string Required
        • value string Required
      • offerwall_code string
      • country string Required

        The country code of the user's location.

  • 406 application/json

    VPN detected

    Hide response attribute Show response attribute object
    • data object
GET /v1/client/user
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/user' \
 --header "X-Api-Token: $API_KEY" \
 --header "X-User-Id: $API_KEY"
Response examples (200)
{
  "data": {
    "app_id": 42,
    "uid": "string",
    "user_id": 42,
    "username": "string",
    "email": "hello@example.com",
    "consent_general": "2022-01-01T12:00:00Z",
    "consent_analytics": "2022-01-01T12:00:00Z",
    "consent_advertising": "2022-01-01T12:00:00Z",
    "terms_of_service_version": 42,
    "privacy_policy_version": 42,
    "custom_fields": [
      {
        "id": "string",
        "value": "string"
      }
    ],
    "offerwall_code": "string",
    "country": "US, GB, DE, etc."
  }
}
Response examples (406)
{
  "error": {
    "details": {
      "msg": "vpn detected",
      "http": "406 Not Acceptable"
    }
  }
}