-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathopenapi_spec.json
More file actions
11482 lines (11482 loc) · 456 KB
/
openapi_spec.json
File metadata and controls
11482 lines (11482 loc) · 456 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.0",
"info": {
"title": "Kickbase API",
"version": "4.5.0",
"description": "Unofficial Kickbase API Specification"
},
"servers": [
{
"url": "https://api.kickbase.com"
}
],
"paths": {
"/v4/challenges/favorites/{favoriteUserId}": {
"delete": {
"summary": "DELETE /v4/challenges/favorites/{favoriteUserId}",
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request"
}
},
"tags": [
"v4",
"challenges",
"favorites",
"{favoriteUserId}"
],
"description": "# Remove Manager From Favorites\n\nThis endpoint removes a manager from the authenticated user's favorites list in the Kickbase challenges system.\n\n## Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `favoriteUserId` | integer | Yes | The unique ID of the manager to remove from your favorites list |\n\n**Example:** `1234`\n\n## Authentication\n\nThis endpoint requires authentication using a **Bearer Token**. Include your access token in the Authorization header:\n\n```\nAuthorization: Bearer {{token}}\n\n ```\n\nThe token should be obtained through the authentication flow and stored in your environment variables.\n\n## Request Headers\n\n- `Accept: application/json` - Specifies the expected response format\n \n\n## Responses\n\n### Success Response (200 OK)\n\nThe manager has been successfully removed from your favorites list. The response will confirm the removal operation.\n\n### Error Response (400 Bad Request)\n\nThe request failed due to invalid input. Common causes include:\n\n- Invalid or non-existent `favoriteUserId`\n \n- Manager is not currently in your favorites list\n \n- Malformed request parameters\n \n\n## Usage Notes\n\n- You can only remove managers that are currently in your favorites list\n \n- The `favoriteUserId` must correspond to a valid manager in the system\n \n- This operation is idempotent - attempting to remove a manager that's not in your favorites will result in a 400 error\n \n- Ensure your authentication token is valid and has not expired before making the request\n \n\n## Best Practices\n\n1. **Verify the manager ID** before attempting removal to avoid unnecessary error responses\n \n2. **Handle errors gracefully** by checking for 400 status codes and providing user-friendly feedback\n \n3. **Refresh your token** if you receive authentication errors\n \n4. **Check your favorites list** after removal to confirm the operation succeeded"
},
"parameters": [
{
"name": "favoriteUserId",
"in": "path",
"required": true,
"description": "(Required) ",
"schema": {
"type": "integer"
},
"example": "1234"
}
]
},
"/v4/challenges/favorites": {
"post": {
"summary": "POST /v4/challenges/favorites",
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request"
}
},
"tags": [
"v4",
"challenges",
"favorites"
],
"description": "# Add Manager to Favorites\n\n## Overview\n\nThis endpoint allows you to add a manager or user to your favorites list in the Kickbase application. By marking a manager as a favorite, you can quickly access and track their performance throughout the season.\n\n## Authentication\n\nThis endpoint requires authentication using a Bearer token. Include your access token in the Authorization header:\n\n```\nAuthorization: Bearer {{token}}\n\n ```\n\nThe `{{token}}` variable should be set in your environment with a valid access token obtained through the Kickbase authentication flow.\n\n## Request Body\n\nThe request body must be sent as JSON with the following parameter:\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ui` | string | Yes | The unique identifier of the user/manager you want to add to favorites. This should be a valid user ID from the Kickbase system. |\n\n### Example Request Body\n\n``` json\n{\n \"ui\": \"1234\"\n}\n\n ```\n\n## Responses\n\n### Success Response (200 OK)\n\nThe manager has been successfully added to your favorites list. See the \"200\" example for the complete response structure.\n\n### Error Response (400 Bad Request)\n\nThe request failed due to invalid input or business logic constraints. This may occur if:\n\n- The `ui` parameter is missing or invalid\n \n- The user ID does not exist\n \n- The manager is already in your favorites\n \n- You've reached the maximum number of favorites allowed\n \n\nSee the \"400\" example for the error response structure.\n\n## Usage Notes\n\n- Ensure the user ID (`ui`) corresponds to a valid manager in the Kickbase system\n \n- Check your current favorites list before adding to avoid duplicate entries\n \n- The endpoint is part of the challenges feature set in Kickbase v4 API\n \n- Rate limiting may apply - refer to the API's general rate limit documentation\n \n\n## Related Endpoints\n\nYou may also want to explore:\n\n- GET /v4/challenges/favorites - Retrieve your current favorites list\n \n- DELETE /v4/challenges/favorites/{ui} - Remove a manager from favorites",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ui": {
"type": "string",
"format": "utc-millisec"
}
}
},
"example": {
"ui": "1234"
}
}
}
}
}
},
"/v4/challenges/socialhub/{followedUserId}": {
"delete": {
"summary": "DELETE /v4/challenges/socialhub/{followedUserId}",
"responses": {
"default": {
"description": ""
}
},
"tags": [
"v4",
"challenges",
"socialhub",
"{followedUserId}"
],
"description": "Removes (unfollows) a user from the Social Hub within the challenges context. This endpoint deletes the social connection between the authenticated user and the specified followed user.\n\n## Path Variables\n\n| Variable | Type | Description |\n|---|---|---|\n| `followedUserId` | string | The unique ID of the user to unfollow. Example: `123` |\n\n## Headers\n\n| Key | Value | Description |\n|---|---|---|\n| `Accept` | `application/json` | Specifies that the response should be returned in JSON format |\n\n## Response\n\nOn success, the server returns a response confirming the user has been unfollowed. If the specified `followedUserId` does not exist or the authenticated user is not following them, an appropriate error response is returned."
},
"parameters": [
{
"name": "followedUserId",
"in": "path",
"required": true,
"description": "(Required) ",
"schema": {
"type": "integer"
},
"example": "123"
}
]
},
"/v4/challenges/socialhub/invitation": {
"get": {
"summary": "GET /v4/challenges/socialhub/invitation",
"responses": {
"200": {
"description": "GET /v4/challenges/socialhub/invitation",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Mon, 02 Mar 2026 10:42:41 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d5fcbd14e98469d-TXL"
},
"Cache-Control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"Content-Encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"socialhub",
"invitation"
],
"description": "## Get SocialHub Challenge Invitation\n\nRetrieves the current user's invitation details for a SocialHub challenge. This endpoint is used to check whether the authenticated user has a pending or active invitation to participate in a SocialHub challenge.\n\n### Authentication\n\nThis request requires a valid authentication token. Set the `token` variable in your active environment before sending.\n\n### Request Headers\n\n| Header | Value |\n|--------|-------|\n| `Accept` | `application/json` |\n\n### Path / Variables\n\n| Variable | Description |\n|----------|-------------|\n| `baseUrl` | The base URL of the Kickbase API (e.g. `https://api.kickbase.com`) |\n\n### Response\n\n**200 OK** — Returns the SocialHub challenge invitation details for the authenticated user.\n\n```json\n{}\n```\n\n> **Note:** A `200` response with an empty body (`{}`) may indicate that no active invitation exists, or that the invitation data is not yet available."
}
},
"/v4/challenges/socialhub/search": {
"get": {
"summary": "GET /v4/challenges/socialhub/search",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "GET /v4/challenges/socialhub/search",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:30:10 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e14237ed61550-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"socialhub",
"search"
],
"description": "## Search Social Hub Challenges\n\nSearch for public Social Hub challenges available on the Kickbase platform. This endpoint allows you to find challenges by keyword and supports pagination through the results.\n\n---\n\n### Authentication\n\nThis request inherits **Bearer Token** authentication from the collection. The `{{token}}` variable must be set in your active environment with a valid access token obtained after login.\n\n```\nAuthorization: Bearer {{token}}\n\n ```\n\n---\n\n### Headers\n\n| Key | Value | Description |\n| --- | --- | --- |\n| `Accept` | `application/json` | Specifies that the response should be returned as JSON. |\n\n---\n\n### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `start` | integer | No | The zero-based offset for pagination. Use this to skip a number of results and retrieve the next page. |\n| `max` | integer | No | The maximum number of results to return per page. |\n| `query` | string | No | A search keyword to filter challenges by name or other relevant fields. Leave empty to retrieve all available challenges. |\n\n---\n\n### Example Response\n\nA successful `200 OK` response returns a list of matching Social Hub challenges:\n\n``` json\n{\n \"it\": [\n {\n \"ui\": \"123\",\n \"unm\": \"abc\",\n \"dvim\": \"content/file/123abc.png\",\n \"uim\": \"user/123abc.jpeg\",\n \"ipic\": true\n }\n ]\n}\n\n ```\n\n| Field | Description |\n| --- | --- |\n| `it` | Array of challenge/user result items. |\n| `ui` | User/challenge identifier. |\n| `unm` | Username or challenge name. |\n| `dvim` | Default/cover image path. |\n| `uim` | User profile image path. |\n| `ipic` | Boolean indicating whether a profile picture is set. |"
}
},
"/v4/challenges/socialhub": {
"get": {
"summary": "GET /v4/challenges/socialhub",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "GET /v4/challenges/socialhub",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:31:42 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e167158bff56c-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"socialhub"
],
"description": "## GET Social Hub Challenges\n\nRetrieves a list of **Social Hub challenges** from the Kickbase fantasy football platform. Social Hub challenges are community-based challenges that players can participate in within the game.\n\n---\n\n### Authentication\n\nThis endpoint requires a valid bearer token. Include the token in the `Authorization` header:\n\n```\nAuthorization: Bearer {{token}}\n```\n\n---\n\n### Query Parameters\n\n| Parameter | Type | Required | Description |\n|-----------|---------|----------|----------------------------------------------------------|\n| `start` | integer | No | Pagination offset — the index of the first result to return. Defaults to `0` if omitted. |\n| `max` | integer | No | Maximum number of results to return per page. Use in combination with `start` for pagination. |\n\n---\n\n### Headers\n\n| Header | Value |\n|----------|--------------------|\n| `Accept` | `application/json` |\n\n---\n\n### Example Request\n\n```\nGET {{baseUrl}}/v4/challenges/socialhub?start=0&max=20\n```\n\n---\n\n### Response\n\nReturns a JSON object containing the list of Social Hub challenges. Use the `start` and `max` parameters to paginate through large result sets."
},
"post": {
"summary": "POST /v4/challenges/socialhub",
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request"
}
},
"tags": [
"v4",
"challenges",
"socialhub"
],
"description": "## Post to Social Hub Challenge\n\nSubmits a request to the Social Hub challenge endpoint.\n\n**Endpoint:** `POST {{baseUrl}}/v4/challenges/socialhub`\n\n### Headers\n\n| Key | Value |\n| --- | --- |\n| `Content-Type` | `application/json` |\n| `Accept` | `application/json` |\n\n### Request Body\n\n``` json\n{\n \"ui\": \"123\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `ui` | `string` | The UI identifier associated with the social hub challenge submission. |\n\n### Authentication\n\nThis request requires a valid `token` variable to be set in the active environment (e.g., **Kickbase v4**). Ensure `baseUrl` is also configured to point to the correct API base URL.\n\n### Notes\n\n- The request body must be valid JSON.\n \n- The `token` variable is expected to be set prior to sending this request (e.g., via a login/authentication request).",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ui": {
"type": "string",
"format": "color"
}
}
},
"example": {
"ui": "123"
}
}
}
}
}
},
"/v4/challenges/archive": {
"get": {
"summary": "GET /v4/challenges/archive",
"responses": {
"200": {
"description": "GET /v4/challenges/archive",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:33:27 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e19043a2c889c-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"archive"
],
"description": "## GET /v4/challenges/archive\n\nRetrieves a list of **archived (past/completed) challenges** from the Kickbase API.\n\n### Description\n\nThis endpoint returns all challenges that have already ended or been completed. Use it to browse historical challenge data, review past results, or display a challenge history to users.\n\n### Request\n\n| Property | Value |\n|----------|-------|\n| Method | `GET` |\n| URL | `{{baseUrl}}/v4/challenges/archive` |\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| `Accept` | `application/json` | Specifies that the response should be returned in JSON format. |\n\n### Response\n\nReturns a JSON object or array containing archived challenge entries. Each challenge typically includes details such as the challenge ID, name, dates, and final standings or results.\n\n### Notes\n\n- This endpoint only returns **past/completed** challenges. For active or upcoming challenges, use the appropriate challenges endpoint.\n- Ensure the `{{baseUrl}}` variable is set correctly in your active environment (e.g., `Kickbase v4`).\n- Authentication may be required — make sure the `token` variable is set in your environment and passed via the appropriate auth header or mechanism."
}
},
"/v4/challenges/lobby/archive": {
"get": {
"summary": "GET /v4/challenges/lobby/archive",
"responses": {
"200": {
"description": "GET /v4/challenges/lobby/archive",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Tue, 03 Mar 2026 14:12:58 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d693d3af9c7d81e-TXL"
},
"Cache-Control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"Content-Encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"lobby",
"archive"
],
"description": "## GET /v4/challenges/lobby/archive\n\nRetrieves a list of **archived (past) lobby challenges**. This endpoint returns previously completed challenge seasons and their associated matchday challenges, grouped by season and calendar week.\n\n### Response Structure\n\nThe response contains a top-level `it` array, where each entry represents a **season group** with the following fields:\n\n| Field | Description |\n|-------|-------------|\n| `wn` | Calendar week number |\n| `csy` | Challenge season year (e.g. `\"2025\"`) |\n| `it` | Array of individual challenges within this season/week |\n\nEach challenge object inside `it` includes:\n\n| Field | Description |\n|-------|-------------|\n| `ch` | Challenge ID |\n| `chn` | Challenge name (e.g. `\"Bundesliga Matchday Challenge #24\"`) |\n| `chim` | Challenge image path |\n| `col` | Accent color (hex) associated with the challenge |\n| `p` | Points scored |\n| `top` | Top percentile rank achieved |\n| `skp` | Score/points delta (can be negative) |\n| `sid` | Season ID |\n| `day` | Matchday number |\n| `li` | League instance ID |\n| `cpi` | Challenge participation ID |\n| `cht` | Challenge type |\n| `clpc` | Challenge leaderboard position count |\n| `ispd` | Whether the challenge is paid/premium (`boolean`) |\n\n### Notes\n- Requires a valid `token` in the active environment for authentication.\n- Results are ordered by season and week, making it useful for reviewing historical challenge performance."
}
},
"/v4/challenges/lobby/divisionLadder": {
"get": {
"summary": "GET /v4/challenges/lobby/divisionLadder",
"responses": {
"200": {
"description": "GET /v4/challenges/lobby/divisionLadder",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:36:27 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e1d68ade63314-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"lobby",
"divisionLadder"
],
"description": "## GET Division Ladder — Challenges Lobby\n\nRetrieves the **division ladder** for the challenges lobby in Kickbase. This endpoint returns the ranked standings of players or teams within their respective division, as part of the challenges feature.\n\n### Use Case\n\nUse this endpoint to display the current division rankings in the challenges lobby — useful for showing a user's position relative to other competitors in their division during an active challenge season.\n\n### Authentication\n\nThis request requires a valid bearer token. Set the `token` variable in your active environment:\n\n```\nAuthorization: Bearer {{token}}\n```\n\n### Request\n\n| Property | Value |\n|----------|-------|\n| Method | `GET` |\n| URL | `{{baseUrl}}/v4/challenges/lobby/divisionLadder` |\n\n**Headers**\n\n| Key | Value |\n|-----|-------|\n| `Accept` | `application/json` |\n\n### Variables\n\n| Variable | Description |\n|----------|-------------|\n| `baseUrl` | The base URL of the Kickbase API (e.g. `https://api.kickbase.com`) |\n| `token` | A valid authentication token obtained after login |\n\n### Response\n\nReturns a JSON object containing the division ladder, including ranked entries with user/team details and their scores or points within the current challenge division.\n\n> See the saved example **\"GET /v4/challenges/lobby/divisionLadder\"** for a sample response."
}
},
"/v4/challenges/lobby/explore/{challengeId}": {
"get": {
"summary": "GET /v4/challenges/lobby/explore/{challengeId}",
"responses": {
"200": {
"description": "GET /v4/challenges/lobby/explore/{challengeId}",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:38:33 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e207ded81e523-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"lobby",
"explore",
"{challengeId}"
],
"description": "## GET Challenge Lobby Details\n\nRetrieves details about a specific challenge lobby by its ID from the Kickbase API. Use this endpoint to explore the lobby information for a given challenge.\n\n---\n\n### Path Variables\n\n| Variable | Description |\n|---|---|\n| `challengeId` | The unique ID of the challenge to explore |\n\n---\n\n### Authentication\n\nThis request requires a bearer token passed via the `{{token}}` variable:\n\n```\nAuthorization: Bearer {{token}}\n```\n\n---\n\n### Response\n\nReturns a JSON object containing the details of the specified challenge lobby.\n\n- **Content-Type:** `application/json`"
},
"parameters": [
{
"name": "challengeId",
"in": "path",
"required": true,
"description": "(Required) ",
"schema": {
"type": "integer"
},
"example": "1"
}
]
},
"/v4/challenges/lobby/explore": {
"get": {
"summary": "GET /v4/challenges/lobby/explore",
"responses": {
"200": {
"description": "GET /v4/challenges/lobby/explore",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:37:50 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e1f705ce0e523-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"lobby",
"explore"
],
"description": "## Explore Challenge Lobby\n\nReturns publicly available challenge lobby data for exploration, including available competitions (`cps`), sponsored challenges (`spo`), and slug-based challenges (`slg`). This endpoint is used to populate the challenge discovery/explore screen.\n\n---\n\n### Method & URL\n\n```\nGET {{baseUrl}}/v4/challenges/lobby/explore\n```\n\n---\n\n### Authentication\n\nThis request uses **Bearer Token** authentication inherited from the collection. The `{{token}}` variable must be set in the active environment with a valid user token.\n\n```\nAuthorization: Bearer {{token}}\n```\n\n---\n\n### Headers\n\n| Key | Value | Description |\n| --- | --- | --- |\n| `Accept` | `application/json` | Specifies that the response should be in JSON format |\n\n---\n\n### Query Parameters\n\nNone.\n\n---\n\n### Example Response — `200 OK`\n\n```json\n{\n \"cps\": [\n {\n \"i\": \"1\",\n \"n\": \"Bundesliga\",\n \"cpim\": \"content/file/2beed7fec3534109a0cc13adfc372f8b.png\"\n }\n ],\n \"spo\": [\n {\n \"ch\": \"699\",\n \"f\": \"content/file/26141186164840828a6a72fa47e5a1c3.jpe\",\n \"t\": 2,\n \"sd\": \"2026-02-27T19:30:00Z\",\n \"isn\": false,\n \"il\": false\n }\n ],\n \"slg\": []\n}\n```\n\n### Response Fields\n\n**`cps`** — Array of available competitions\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `i` | string | Competition ID |\n| `n` | string | Competition name (e.g. `\"Bundesliga\"`) |\n| `cpim` | string | Relative path to the competition image |\n\n**`spo`** — Array of sponsored/featured challenges\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `ch` | string | Challenge ID |\n| `f` | string | Relative path to the challenge image/thumbnail |\n| `t` | number | Challenge type identifier |\n| `sd` | string (ISO 8601) | Challenge start date/time in UTC |\n| `isn` | boolean | Whether the challenge is new |\n| `il` | boolean | Whether the challenge is locked |\n\n**`slg`** — Array of slug-based challenges (empty if none available)"
}
},
"/v4/challenges/lobby/overview/live": {
"get": {
"summary": "GET /v4/challenges/lobby/overview/live",
"responses": {
"200": {
"description": "GET /v4/challenges/lobby/overview/live",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:40:18 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e230ba9f6e52f-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"lobby",
"overview",
"live"
],
"description": "## GET Live Challenge Lobby Overview\n\nRetrieves the **live overview** of the challenge lobby, providing real-time data about currently active challenges.\n\n### Endpoint\n\n```\nGET {{baseUrl}}/v4/challenges/lobby/overview/live\n```\n\n### Authentication\n\nThis request requires a valid bearer token passed via the `{{token}}` variable. Ensure the token is set in your active environment before sending the request.\n\n### Request Headers\n\n| Header | Value | Description |\n|--------|-------|-------------|\n| `Accept` | `application/json` | Specifies that the response should be in JSON format |\n\n### Variables\n\n| Variable | Description |\n|----------|-------------|\n| `{{baseUrl}}` | The base URL of the Kickbase API (e.g., `https://api.kickbase.com`) |\n| `{{token}}` | The authentication token obtained after login |\n\n### Response\n\nReturns a JSON object containing the live challenge lobby overview, including details about ongoing challenges available to the user.\n\n### Notes\n\n- This endpoint reflects **live/real-time** data and may change frequently during active challenge periods.\n- Make sure the `Kickbase v4` environment is active and the `token` variable is populated (e.g., by running the login request first)."
}
},
"/v4/challenges/lobby/overview": {
"get": {
"summary": "GET /v4/challenges/lobby/overview",
"responses": {
"200": {
"description": "GET /v4/challenges/lobby/overview",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:40:46 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e23b7aba1e52f-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},
"tags": [
"v4",
"challenges",
"lobby",
"overview"
],
"description": "## GET Challenges Lobby Overview\n\nRetrieves a summary overview of the challenges lobby, providing high-level information about available and active challenges.\n\n### Request\n\n| Property | Value |\n|----------|-------|\n| Method | `GET` |\n| Endpoint | `/v4/challenges/lobby/overview` |\n\n### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| `Accept` | `application/json` | Specifies that the response should be returned in JSON format |\n\n### Authentication\n\nThis request requires a valid bearer token. Set the `token` variable in your environment:\n\n```\nAuthorization: Bearer {{token}}\n```\n\n### Response\n\nReturns a JSON object containing an overview of the challenges lobby. This typically includes:\n\n- A list of currently available challenges\n- Summary statistics (e.g., number of active challenges, participants)\n- Lobby status and metadata\n\n### Example\n\nA saved example is available — **GET /v4/challenges/lobby/overview** — demonstrating a typical successful response from this endpoint.\n\n### Notes\n\n- Ensure `baseUrl` and `token` are set in your active environment (`Kickbase v4`) before sending this request.\n- The `challengeId` variable can be used in related challenge endpoints to drill down into specific challenge details."
}
},
"/v4/challenges/lobby/profile": {
"get": {
"summary": "GET /v4/challenges/lobby/profile",
"responses": {
"200": {
"description": "GET /v4/challenges/lobby/profile",
"headers": {
"Date": {
"schema": {
"type": "string"
},
"example": "Thu, 26 Feb 2026 08:42:51 GMT"
},
"Transfer-Encoding": {
"schema": {
"type": "string"
},
"example": "chunked"
},
"Connection": {
"schema": {
"type": "string"
},
"example": "keep-alive"
},
"CF-RAY": {
"schema": {
"type": "string"
},
"example": "9d3e26c60e1823ee-TXL"
},
"cache-control": {
"schema": {
"type": "string"
},
"example": "no-store, no-cache"
},
"content-encoding": {
"schema": {
"type": "string"
},
"example": "br"
},
"vary": {
"schema": {
"type": "string"
},
"example": "Accept-Encoding"
},
"cf-cache-status": {
"schema": {
"type": "string"
},
"example": "DYNAMIC"
},
"Server": {
"schema": {
"type": "string"
},
"example": "cloudflare"
}
}
}
},