---
title: "Get Surveys"
method: GET
path: "/v2/client/surveys"
tags: ["Surveys"]
---

# Get Surveys

`GET /v2/client/surveys`

Returns a list of surveys that are available for the current user. This is the endpoint that should be used to display surveys to the user. If a simple integration flow is desired, this is the only endpoint that must be implemented. Redirecting to the `click_url` property of the returned surveys will open the survey in the BitLabs.

## Query parameters

- `platform` 'MOBILE' | 'TABLET' | 'WEB'
- `os` 'ANDROID' | 'IOS' | 'DESKTOP'
- `sdk` 'CUSTOM' | 'IFRAME' | 'TAB' | 'NATIVE' | 'UNITY' | 'REACT' | 'FLUTTER'
- `tags` string, URL-encoded query
- `bb_track` string
- `client_ip` string
- `client_useragent` string
- `username` string
- `maid` string
- `network_blacklist` string
- `algo` 'UX' | 'QC'
- `email` string

## Response `200`

OK

- object
  - `data` V2Surveys
    - `restriction_reason` V2RestrictionReason — The following combinations are possible: - { not_verified } - { using_vpn } - { banned_until, reason } - { unsupported_country } - { banned } - { review } - { on_hold }
      - `not_verified` boolean — The publisher account that owns this app has not been verified and therefore cannot receive surveys.
      - `using_vpn` boolean — The user is using a VPN and cannot access surveys. This is the only endpoint that does not return HTTP 406 in this case.
      - `banned_until` string, RFC3339 — It can happen that we ban users temporarily if we deem necessary. The time is in RFC3339 and represents the end of the ban.
      - `reason` string — A translated reason for the ban.
      - `unsupported_country` string — In case users from a country that we do not offer surveys for are trying to access this endpoint.
      - `banned` boolean — If the user is banned permanently.
      - `review` boolean — If the user is under review.
      - `on_hold` boolean — If the user is on hold.
    - `surveys` V2Survey[], required
      - `id` string, required
      - `type` 'survey' | 'start_bonus', required
      - `click_url` string, required
      - `cpi` string, required — CPI of this survey in USD without any formatting applied.
      - `value` string, required — CPI formatted according to your app settings. Can be shown to the user directly.
      - `cr` number, float, required — Conversion rate of the survey. Value in percent between 0 and 1.
      - `loi` number, float, required — Assumed length of the survey in minutes
      - `country` string, ISO 3166-1 alpha-2, required
      - `language` string, ISO 639-1, required
      - `rating` integer, required — Difficulty ranking of this survey. 1-5 (1 = hard, 5 = easy)
      - `category` V2SurveyCategory, required
        - `name` string, required — Localized category name
        - `icon_name` string, required
        - `icon_url` string, required — If not empty: url to an icon for the category.
        - `name_internal` string, required — Internal, un-localized, machine-friendly name of the category
      - `tags` V2SurveyTags[], required

---

[API](https://skmtc.net/bitlabs/apis/bitlabs-client-api.md) · [All operations](https://skmtc.net/bitlabs/apis/bitlabs-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitlabs/bitlabs-client-api/revisions/99209a6285bf/schema)