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

Desafios

homolog
https://api2-homolog.vik.app
homolog
https://api2-homolog.vik.app
GET
{{BASE_URL}}/api/v1/challenges
Retorna dados sobre os desafios disponíveis e a participação dos colaboradores.

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
🟠422Erro de parâmetro
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{BASE_URL}}/api/v1/challenges?page=1&challenge_id=21651&start_date=2024-08-01&end_date=2024-09-01&update_start_date=2025-09-01&update_end_date=2025-10-30' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Sucesso
{
    "data": [
        {
            "id": 772177714,
            "title": "Challenge_e1a8eca3",
            "enrollment_started_on": "2024-10-09",
            "enrollment_ended_on": "2024-10-10",
            "total_invited": 90,
            "total_enrolled": 28,
            "adhesion": "31%",
            "has_warming_up_step": false,
            "warming_up_started_on": "",
            "warming_up_ended_on": "",
            "promotion_of_teams_date": "2024-10-11",
            "max_team_size": 4,
            "start_date": "2024-10-14",
            "end_date": "2024-11-24",
            "results_publishion_date": "2024-11-27",
            "total_activities": 2,
            "total_coins": 1,
            "created_at": "2024-10-08T20:39:19.732Z",
            "updated_at": "2024-10-09T20:18:44.830Z"
        },
        {
            "id": 455454,
            "title": "Challenge_be3b73c1",
            "enrollment_started_on": "2024-10-07",
            "enrollment_ended_on": "2024-10-17",
            "total_invited": 90,
            "total_enrolled": 15,
            "adhesion": "17%",
            "has_warming_up_step": false,
            "warming_up_started_on": "",
            "warming_up_ended_on": "",
            "promotion_of_teams_date": "2024-10-18",
            "max_team_size": 5,
            "start_date": "2024-10-21",
            "end_date": "2024-11-03",
            "results_publishion_date": "2024-11-04",
            "total_activities": 1,
            "total_coins": 1,
            "created_at": "2024-10-07T18:53:42.126Z",
            "updated_at": "2024-10-11T20:45:35.678Z"
        },
        {
            "id": 9999,
            "title": "Challenge_40f0ebf4",
            "enrollment_started_on": "2024-10-01",
            "enrollment_ended_on": "2024-10-31",
            "total_invited": 90,
            "total_enrolled": 15,
            "adhesion": "17%",
            "has_warming_up_step": false,
            "warming_up_started_on": "",
            "warming_up_ended_on": "",
            "promotion_of_teams_date": "2024-10-01",
            "max_team_size": 5,
            "start_date": "2024-10-01",
            "end_date": "2024-10-31",
            "results_publishion_date": "2024-10-31",
            "total_activities": 63,
            "total_coins": 66,
            "created_at": "2024-09-30T11:51:05.699Z",
            "updated_at": "2024-09-30T11:51:05.699Z"
        }
    ],
    "pagy": {
        "page": 1,
        "per_page": 100,
        "total_items": 152,
        "total_pages": 2,
        "next_page": 2,
        "prev_page": null
    }
}
Modificado em 2025-10-08 13:23:25
Página anterior
Atividades
Próxima página
Cupons
Built with