API VIK
  1. v1
API VIK
  • v1
    • Autenticação
      POST
    • Usuários
      GET
    • Atividades
      GET
    • Desafios
      GET
    • Cupons
      GET
    • Resgates
      GET
    • VIK Scores
      GET
    • health
      GET
  1. v1

Usuários

homolog
https://api2-homolog.vik.app
homolog
https://api2-homolog.vik.app
GET
{{BASE_URL}}/api/v1/users
Retorna os registros de usuários cadastrados

Requisição

Authorization
Adicionar parâmetro em header
x-api-key
Exemplo:
x-api-key: ********************
Parâmetros de Consulta

Respostas

🟢200OK
application/json
Body

🟠401Não autorizado
🟠401Invalid account authorization
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{BASE_URL}}/api/v1/users?page=1&active=true&start_date=2025-01-01&end_date=2025-02-01&update_start_date=2025-10-01&update_end_date=2025-10-30' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Sucesso
{
    "data": [
        {
            "id": 0400420,
            "name": "User_016b643f",
            "email": "user_976f9bea@exemplo.com",
            "birthday": "2000-10-22",
            "cpf": "36958600344",
            "gender": "Masculino",
            "height": 183,
            "weight": 84.0,
            "bmi": 24.78,
            "metabolic_age": 24,
            "created_at": "2024-07-23T18:25:14.070Z",
            "updated_at": "2024-10-11T01:15:13.205Z",
            "initial_physical_condition": "Ativo",
            "total_activities": 35,
            "total_walk_meters": 0.0,
            "total_run_meters": 37000.0,
            "total_bike_meters": 0.0,
            "total_hours_vik_fit": "00:00:00",
            "total_hours_without_gps": "31:36:14",
            "earned_coins": 42,
            "activities_coins": 32,
            "vik_fit_coins": 0,
            "vik_score_coins": 10,
            "extra_coins": 0,
            "used_coins": 20,
            "total_redeemed_coupons": 1,
            "total_received_likes": 229,
            "total_realized_likes": 49,
            "total_received_comments": 82,
            "total_realized_comments": 2,
            "active": "Sim",
            "api": "Não",
            "area": null,
            "subarea": null,
            "challenge_enrollment_ids": [
                2222,
                4324,
                32422
            ]
        },
        {
            "id": 343221441,
            "name": "User_0942b2ac",
            "email": "user_528e022e@exemplo.com",
            "birthday": "2000-10-22",
            "cpf": "00000000000",
            "gender": null,
            "height": 0,
            "weight": 0.0,
            "bmi": 0.0,
            "metabolic_age": 0,
            "created_at": "2024-09-12T00:44:12.785Z",
            "updated_at": "2024-09-12T00:44:12.920Z",
            "initial_physical_condition": "Ativo",
            "total_activities": 0,
            "total_walk_meters": 0.0,
            "total_run_meters": 0.0,
            "total_bike_meters": 0.0,
            "total_hours_vik_fit": "00:00:00",
            "total_hours_without_gps": "00:00:00",
            "earned_coins": 0,
            "activities_coins": 0,
            "vik_fit_coins": 0,
            "vik_score_coins": 0,
            "extra_coins": 0,
            "used_coins": 0,
            "total_redeemed_coupons": 0,
            "total_received_likes": 0,
            "total_realized_likes": 0,
            "total_received_comments": 0,
            "total_realized_comments": 0,
            "active": "Sim",
            "api": "Não",
            "area": "Tecnologia",
            "subarea": "Desenvolvimento de software",
            "challenge_enrollment_ids": [
                432432,
                123123
            ]
        }
    ],
    "pagy": {
        "page": 1,
        "per_page": 100,
        "total_items": 90,
        "total_pages": 1,
        "next_page": null,
        "prev_page": null
    }
}
Modificado em 2025-10-08 13:13:34
Página anterior
Autenticação
Próxima página
Atividades
Built with