-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
2152 lines (2136 loc) · 329 KB
/
index.html
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
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Loopline Systems API</title><link rel="stylesheet" href="css/bootstrap-3.1.1.min.css"><link rel="stylesheet" href="css/font-awesome-4.0.3.min.css"><link rel="stylesheet" href="css/styles.css"><link rel="shortcut icon" href="http://cdn.loopline-systems.com/favicon.ico"><link rel="apple-touch-icon-precomposed" sizes="144x144" href="http://cdn.loopline-systems.com/lls-logo-144.png"></head><body><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container"><div class="row"><div class="col-md-3"><nav class="static"><a href="index.html"><img src="img/lls-logo.png" class="logo"></a><div id="static-pages" class="list-group"><a href="index.html" class="list-group-item heading">Loopline Systems API</a><a href="chrome_postman.html" class="list-group-item">Sandboxing with Postman</a><a href="error_responses.html" class="list-group-item">Error Responses</a><a href="integrations.html" class="list-group-item">Integrations</a><a href="index.html" class="list-group-item">REST API</a></div></nav><nav id="nav" class="hidden-sm hidden-xs affix nav dynamic"><div class="list-group"><a data-toggle="collapse" data-target=".collapse.application-menu" href="#page:application" class="list-group-item heading collapsed"><span class="toggle pull-right"><span class="open fa fa-angle-down"></span><span class="closed fa fa-angle-right"></span></span>Application</a><div id="page:application-menu" class="collapse application-menu"><a href="#page:application,header:application-locale-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Locale List</a><a data-target="#application-locale-list-get" href="#page:application,header:application-locale-list-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get a list of available locales</span></a></div></div><div class="list-group"><a data-toggle="collapse" data-target=".collapse.user-menu" href="#page:user" class="list-group-item heading collapsed"><span class="toggle pull-right"><span class="open fa fa-angle-down"></span><span class="closed fa fa-angle-right"></span></span>User</a><div id="page:user-menu" class="collapse user-menu"><a href="#page:user,header:user-user-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">User List</a><a data-target="#user-user-list-get" href="#page:user,header:user-user-list-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get all users</span></a><a href="#page:user,header:user-user" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">User</a><a data-target="#user-user-get" href="#page:user,header:user-user-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get a single user</span></a><a data-target="#user-user-post" href="#page:user,header:user-user-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Create a new user</span></a><a data-target="#user-user-patch" href="#page:user,header:user-user-patch" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-warning"><i class="fa fa-pencil"></i></span><span class="indent">Update a single user</span></a><a href="#page:user,header:user-supervisee-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Supervisee List</a><a data-target="#user-supervisee-list-get" href="#page:user,header:user-supervisee-list-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get all supervisees of a user</span></a><a href="#page:user,header:user-supervisor" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Supervisor</a><a data-target="#user-supervisor-post" href="#page:user,header:user-supervisor-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Assign a supervisor to a user</span></a><a data-target="#user-supervisor-delete" href="#page:user,header:user-supervisor-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Remove a supervisee from a supervisor</span></a><a href="#page:user,header:user-user-image" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">User Image</a><a data-target="#user-user-image-post" href="#page:user,header:user-user-image-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Update the profile image of a user</span></a><a data-target="#user-user-image-delete" href="#page:user,header:user-user-image-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Delete the profile image of a user</span></a></div></div><div class="list-group"><a data-toggle="collapse" data-target=".collapse.role-menu" href="#page:role" class="list-group-item heading collapsed"><span class="toggle pull-right"><span class="open fa fa-angle-down"></span><span class="closed fa fa-angle-right"></span></span>Role</a><div id="page:role-menu" class="collapse role-menu"><a href="#page:role,header:role-role-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Role List</a><a data-target="#role-role-list-get" href="#page:role,header:role-role-list-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get all roles</span></a><a href="#page:role,header:role-role" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Role</a><a data-target="#role-role-get" href="#page:role,header:role-role-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get a single role</span></a><a href="#page:role,header:role-role-membership" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Role Membership</a><a data-target="#role-role-membership-post" href="#page:role,header:role-role-membership-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Add a role to a user</span></a><a data-target="#role-role-membership-delete" href="#page:role,header:role-role-membership-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Remove a role from a user</span></a></div></div><div class="list-group"><a data-toggle="collapse" data-target=".collapse.team-menu" href="#page:team" class="list-group-item heading collapsed"><span class="toggle pull-right"><span class="open fa fa-angle-down"></span><span class="closed fa fa-angle-right"></span></span>Team</a><div id="page:team-menu" class="collapse team-menu"><a href="#page:team,header:team-team" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Team</a><a data-target="#team-team-get" href="#page:team,header:team-team-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get all teams</span></a><a data-target="#team-team-get" href="#page:team,header:team-team-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get a single team</span></a><a data-target="#team-team-patch" href="#page:team,header:team-team-patch" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-warning"><i class="fa fa-pencil"></i></span><span class="indent">Update a single team</span></a><a data-target="#team-team-delete" href="#page:team,header:team-team-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Delete a single team</span></a><a href="#page:team,header:team-team-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Team List</a><a data-target="#team-team-list-post" href="#page:team,header:team-team-list-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Create a new team</span></a><a href="#page:team,header:team-teamlead" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Teamlead</a><a data-target="#team-teamlead-post" href="#page:team,header:team-teamlead-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Set a new teamlead</span></a><a href="#page:team,header:team-team-membership" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Team Membership</a><a data-target="#team-team-membership-post" href="#page:team,header:team-team-membership-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Add a user to a team</span></a><a data-target="#team-team-membership-delete" href="#page:team,header:team-team-membership-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Delete a user from a team</span></a></div></div><div class="list-group"><a data-toggle="collapse" data-target=".collapse.objectives-menu" href="#page:objectives" class="list-group-item heading collapsed"><span class="toggle pull-right"><span class="open fa fa-angle-down"></span><span class="closed fa fa-angle-right"></span></span>Objectives</a><div id="page:objectives-menu" class="collapse objectives-menu"><a href="#page:objectives,header:objectives-objective-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Objective List</a><a data-target="#objectives-objective-list-get" href="#page:objectives,header:objectives-objective-list-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Returns all objectives for a user</span></a><a href="#page:objectives,header:objectives-objective" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Objective</a><a data-target="#objectives-objective-post" href="#page:objectives,header:objectives-objective-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Create a new objective</span></a><a data-target="#objectives-objective-patch" href="#page:objectives,header:objectives-objective-patch" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-warning"><i class="fa fa-pencil"></i></span><span class="indent">Update an objective</span></a><a data-target="#objectives-objective-delete" href="#page:objectives,header:objectives-objective-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Archive an objective by id</span></a><a href="#page:objectives,header:objectives-objective-key-result" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Objective Key Result</a><a data-target="#objectives-objective-key-result-patch" href="#page:objectives,header:objectives-objective-key-result-patch" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-warning"><i class="fa fa-pencil"></i></span><span class="indent">Update an objective key result</span></a></div></div><div class="list-group"><a data-toggle="collapse" data-target=".collapse.department-menu" href="#page:department" class="list-group-item heading collapsed"><span class="toggle pull-right"><span class="open fa fa-angle-down"></span><span class="closed fa fa-angle-right"></span></span>Department</a><div id="page:department-menu" class="collapse department-menu"><a href="#page:department,header:department-department-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department List</a><a data-target="#department-department-list-get" href="#page:department,header:department-department-list-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get all departments</span></a><a href="#page:department,header:department-department" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department</a><a data-target="#department-department-get" href="#page:department,header:department-department-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get a single department</span></a><a data-target="#department-department-post" href="#page:department,header:department-department-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Add a new department</span></a><a data-target="#department-department-patch" href="#page:department,header:department-department-patch" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-warning"><i class="fa fa-pencil"></i></span><span class="indent">Update basic department information</span></a><a data-target="#department-department-delete" href="#page:department,header:department-department-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Delete a department and its children</span></a><a href="#page:department,header:department-user-department" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">User Department</a><a data-target="#department-user-department-get" href="#page:department,header:department-user-department-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get a users department</span></a><a href="#page:department,header:department-department-tree" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Tree</a><a data-target="#department-department-tree-get" href="#page:department,header:department-department-tree-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get a tree starting with all root departments and their children</span></a><a href="#page:department,header:department-department-member-list" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Member List</a><a data-target="#department-department-member-list-get" href="#page:department,header:department-department-member-list-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get all department members</span></a><a href="#page:department,header:department-department-member" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Member</a><a data-target="#department-department-member-post" href="#page:department,header:department-department-member-post" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-success"><i class="fa fa-plus"></i></span><span class="indent">Add a user to a department</span></a><a data-target="#department-department-member-delete" href="#page:department,header:department-department-member-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Remove a user from a department</span></a><a href="#page:department,header:department-department-relation-adding" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Relation Adding</a><a data-target="#department-department-relation-adding-put" href="#page:department,header:department-department-relation-adding-put" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-warning"><i class="fa fa-pencil"></i></span><span class="indent">Set the parent department for a department</span></a><a href="#page:department,header:department-department-relation-removal" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Relation Removal</a><a data-target="#department-department-relation-removal-delete" href="#page:department,header:department-department-relation-removal-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Remove the parent link for a department</span></a><a href="#page:department,header:department-department-children" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Children</a><a data-target="#department-department-children-get" href="#page:department,header:department-department-children-get" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-info"><i class="fa fa-arrow-down"></i></span><span class="indent">Get all children / descendants of a department</span></a><a href="#page:department,header:department-department-head" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Head</a><a data-target="#department-department-head-put" href="#page:department,header:department-department-head-put" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-warning"><i class="fa fa-pencil"></i></span><span class="indent">Set the head of a department</span></a><a href="#page:department,header:department-department-head-removal" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item resource">Department Head Removal</a><a data-target="#department-department-head-removal-delete" href="#page:department,header:department-department-head-removal-delete" style="border-top-left-radius: 0; border-top-right-radius: 0" class="list-group-item action"><span class="badge alert-danger"><i class="fa fa-times"></i></span><span class="indent">Remove the head of a department</span></a></div></div></nav></div><div id="content" class="col-md-8"><div data-bind="visible: page() == 'home'"><header><div class="page-header"><h1 id="top">API Documentation</h1></div></header><div class="description"><p>Welcome to the <a href="http://www.loopline-systems.com">Loopline Systems</a> REST API specification.</p>
<h2>Getting Started</h2>
<p>Loopline Systems provides a <a href="http://en.wikipedia.org/wiki/Representational_state_transfer">RESTful API</a> for your own integrations.</p>
<p>You can find the available requests on the left hand side bar.
Each request will contain sample requests and responses as well.</p>
<p>Your opinion is important! If you have any suggestions on how we can improve our API to better fit your needs, feel free to <a href="mailto:[email protected]">contact us</a>.</p>
<p><h3 id="usage">Usage</h3></p>
<p>For using the API, you will need a <CLIENT_ID> and an <API_KEY> which you can retrieve both in your admin section.</p>
<p>All data sent and received uses the MIME_TYPE <code>application/json</code>.</p>
<p>API Base URL: <code>https://api.loopline-systems.com</code></p>
<div class="terminal">
<p class="head">Example cURL request</p>
<ul class="body">
<li>
curl https://api.loopline-systems.com/users \<br />-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"
</li>
</ul>
</div>
<h3>Error handling</h3>
<p>If errors occur while communicating with the API you will receive a message that includes the HTTP status-code and a message.</p>
<h3>Sandbox</h3>
<p>Loopline Systems supports the Postman extension for Chrome with a “Request Collection” you can easily import. If you are not familiar with it just have a look at our <a href="chrome_postman.html">tutorial</a>.</p>
<p>–</p>
<p>Thanks <a href="https://www.npmjs.com/~stefanjudis">@Stefan</a> for the nice terminal css look.
<a href="http://codepen.io/stefanjudis/pen/BNOOpX">http://codepen.io/stefanjudis/pen/BNOOpX</a></p>
</div><a href="#page:application" class="btn btn-default pull-right">Next <i class="fa fa-arrow-circle-right"></i></a><div class="clearfix"></div><hr/></div><div data-bind="visible: page() == 'application', style: {marginTop: page() == 'application' ? '38px' : ''}"><div class="panel panel-default"><div class="panel-heading"><h3 id="application">Application <a href="#page:application"><i class="fa fa-link"></i></a></h3></div><div class="panel-body"><h4 id="application-locale-list">Locale List <a href="#page:application,header:application-locale-list"><i class="fa fa-link"></i></a></h4><section id="application-locale-list-get" class="panel panel-info"><div data-toggle="collapse" data-target="#application-locale-list-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get a list of available locales</span></div><div style="float:left"><a href="#page:application,header:application-locale-list-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/application/locales</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li data-toggle="collapse" data-target="#e35cc9f53761e4753c14a6999edef482" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="e35cc9f53761e4753c14a6999edef482" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /application/locales</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/application/locales \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#416606440978a2b6769c448cc7c689df" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="416606440978a2b6769c448cc7c689df" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">locale</span>": <span class="hljs-value"><span class="hljs-string">"en_US"</span></span>,
"<span class="hljs-attribute">key</span>": <span class="hljs-value"><span class="hljs-string">"LANGUAGE.EN_US"</span>
</span>},
{
"<span class="hljs-attribute">locale</span>": <span class="hljs-value"><span class="hljs-string">"de_DE"</span></span>,
"<span class="hljs-attribute">key</span>": <span class="hljs-value"><span class="hljs-string">"LANGUAGE.DE_DE"</span>
</span>},
{
"<span class="hljs-attribute">locale</span>": <span class="hljs-value"><span class="hljs-string">"fr_FR"</span></span>,
"<span class="hljs-attribute">key</span>": <span class="hljs-value"><span class="hljs-string">"LANGUAGE.FR_FR"</span>
</span>}
]
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#6300ddb80832230c3c7fec4eb1994851" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="6300ddb80832230c3c7fec4eb1994851" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li></ul></div></section></div></div><a href="#page:user" class="btn btn-default pull-right">Next <i class="fa fa-arrow-circle-right"></i></a><a href="#" class="btn btn-default"><i class="fa fa-arrow-circle-left"></i> Previous</a><div class="clearfix"></div><hr/></div><div data-bind="visible: page() == 'user', style: {marginTop: page() == 'user' ? '38px' : ''}"><div class="panel panel-default"><div class="panel-heading"><h3 id="user">User <a href="#page:user"><i class="fa fa-link"></i></a></h3></div><div class="panel-body"><h4 id="user-user-list">User List <a href="#page:user,header:user-user-list"><i class="fa fa-link"></i></a></h4><section id="user-user-list-get" class="panel panel-info"><div data-toggle="collapse" data-target="#user-user-list-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get all users</span></div><div style="float:left"><a href="#page:user,header:user-user-list-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/users</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>deactivated</dt><dd><code>bool</code> <span>(optional)</span> <p>Whether to include deactivated users in results (admin only)</p>
</dd><dt>page</dt><dd><code>integer (\d+)</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>1</span></span> <p>page number to display</p>
</dd><dt>maxresults</dt><dd><code>integer (\d+)</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>25</span></span> <p>results per page to display</p>
</dd><dt>search</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>search term (OR)</p>
</dd><dt>filter</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>filter type (all|users_active|users_admin|users_can_be_supervisor|users_non_active|users_without_supervisor|users_no_position|users_pending|users_pending_without_invitation|have_individual_feedback_period|have_no_individual_feedback_period)</p>
</dd><dt>sort</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>property to sort by</p>
</dd><dt>sortOrder</dt><dd><code>string (\s+)</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>ASC</span></span> <p>sort order (ASC|DESC)</p>
</dd><dt>excludeIds</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>comma separated list of IDs to exclude</p>
</dd><dt>searchBy</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>comma separated list of search groups (defaults to “default”)</p>
</dd><dt>include</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>comma separated list of what to include in response. See config request for options</p>
</dd><dt>team</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>include team in the response</p>
</dd><dt>department</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>include department in the response</p>
</dd><dt>supervisor</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>include supervisor in the response</p>
</dd><dt>tos</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>include tos in the response</p>
</dd><dt>active_stats</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>include active stats in the response</p>
</dd><dt>roles</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>include roles in the response</p>
</dd><dt>createdAfter</dt><dd><code>date</code> <span>(optional)</span> <p>Return users created after (and including) this date</p>
</dd><dt>createdBefore</dt><dd><code>date</code> <span>(optional)</span> <p>Return users created before (and including) this date</p>
</dd><dt>supervisorId</dt><dd><code>int</code> <span>(optional)</span> <p>Filter users based on their supervisor</p>
</dd><dt>includeDownstream</dt><dd><code>bool</code> <span>(optional)</span> <p>If you set a supervisor do you want also include their downstream</p>
</dd><dt>departmentId</dt><dd><code>int</code> <span>(optional)</span> <p>Filter users based on their department</p>
</dd><dt>departmentDirect</dt><dd><code>bool</code> <span>(optional)</span> <p>If true will exclude members of child departments (will not work for historic data)</p>
</dd><dt>superviseeDepartmentMemberships</dt><dd><code>bool</code> <span>(optional)</span> <p>If true will include supervisees’ department memberships (will not work for historic data)</p>
</dd><dt>activeFeedbackPeriodConfigId</dt><dd><code>int</code> <span>(optional)</span> <p>Filter users based on their active feedback period</p>
</dd><dt>feedbackStatus</dt><dd><code>string (ongoing|prepared|completed|deactivated)</code> <span>(optional)</span> <p>Filter by feedback status: ongoing|prepared|completed|deactivated</p>
</dd><dt>teamId</dt><dd><code>int</code> <span>(optional)</span> <p>Filter users based on their team</p>
</dd><dt>superviseeTeamMemberships</dt><dd><code>bool</code> <span>(optional)</span> <p>If true will include supervisees’ team memberships (will not work for historic data)</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#9d2f137462a8dac4ee68b1f521690087" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="9d2f137462a8dac4ee68b1f521690087" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /users</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#d1758fbcfa275d8a3aa5699d3079cd78" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="d1758fbcfa275d8a3aa5699d3079cd78" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">sort</span>": <span class="hljs-value">{
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"firstname"</span></span>,
"<span class="hljs-attribute">order</span>": <span class="hljs-value"><span class="hljs-string">"ASC"</span>
</span>}</span>,
"<span class="hljs-attribute">filter</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">count</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">currentPage</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">maxPerPage</span>": <span class="hljs-value"><span class="hljs-number">25</span></span>,
"<span class="hljs-attribute">hasNextPage</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">hasPreviousPage</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">haveToPaginate</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">getCurrentPageOffsetEnd</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">getCurrentPageOffsetStart</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">getNbPages</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>}</span>,
"<span class="hljs-attribute">results</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">18</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Alex"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Millner"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">18</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/69731449a4c782b76d43d9b83c9f07de.jpeg"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"Customer Success Agent"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">6</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER_ACCEPTED_TOS"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
</span>}
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">16</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Paul"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Newman"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">16</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/fc14943abea097f70690de081821f245.jpeg"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"Sales Agent"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Graig"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Greening"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"Head of Sales"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">10</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Anton"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Mozart"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">10</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/d337d1606222162034fbf29c641d7672.jpeg"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"Senior Ruby Developer"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_SUPERVISOR"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">6</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER_ACCEPTED_TOS"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">7</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_CAN_BE_SUPERVISOR"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Lucas"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Mancini"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/dbed81c3cf1c2c4c0d1ec79d624e3259.jpeg"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CTO"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Catrina"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Carnahan"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CFO"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}
]
</span>}
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#6bca2a6e287e10fc9526b35967463abb" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="6bca2a6e287e10fc9526b35967463abb" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li></ul></div></section><h4 id="user-user">User <a href="#page:user,header:user-user"><i class="fa fa-link"></i></a></h4><section id="user-user-get" class="panel panel-info"><div data-toggle="collapse" data-target="#user-user-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get a single user</span></div><div style="float:left"><a href="#page:user,header:user-user-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/users/{id}</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the user</p>
</dd><dt>extend</dt><dd><code>integer (\d+)</code> <span>(optional)</span> <p>Extends the response data</p>
<p><strong>Choices: </strong><code>1</code> </p></dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#119fe860851fa6c922e3bfc41b4060cc" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="119fe860851fa6c922e3bfc41b4060cc" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /users/{id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id> \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#fc5383c262e9ee3c21aff23110830e0c" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="fc5383c262e9ee3c21aff23110830e0c" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CEO"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Active user"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Christian"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Miller"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/christian.miller.jpg"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CEO"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">recommendable</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">teams</span>": <span class="hljs-value">[]</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"08-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">recommendable</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">teams</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"HR"</span></span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>}
]</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"08-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#0346930ebbe22ec99f47aab171d4ecc2" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="0346930ebbe22ec99f47aab171d4ecc2" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /users/{id}</p>
<ul class="body">
<li>curl /users/{id}?extend=1 \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#e2687d215eab620a2093ec6c0dcf9fc8" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="e2687d215eab620a2093ec6c0dcf9fc8" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">40</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"7566f0404037cede5bb3d742194d28c2.jpeg"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/7566f0404037cede5bb3d742194d28c2.jpeg"</span>
</span>}</span>,
"<span class="hljs-attribute">organization</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Loopline Systems GmbH"</span></span>,
"<span class="hljs-attribute">logo</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"d47965e73e19a1ef8b5eeb0f2318a982.png"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/d47965e73e19a1ef8b5eeb0f2318a982.png"</span>
</span>}</span>,
"<span class="hljs-attribute">systemEmail</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">globalFeedbackPeriodDuration</span>": <span class="hljs-value"><span class="hljs-string">"4 months"</span></span>,
"<span class="hljs-attribute">globalFeedbackOpenDuration</span>": <span class="hljs-value"><span class="hljs-string">"1 month"</span></span>,
"<span class="hljs-attribute">refreshTimeouts</span>": <span class="hljs-value">{
"<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">30000</span></span>,
"<span class="hljs-attribute">user</span>": <span class="hljs-value"><span class="hljs-number">18000</span>
</span>}</span>,
"<span class="hljs-attribute">initialSetupDone</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CEO"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Active user"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Allows user to login"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_SUPERVISOR"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Currently supervisor"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Can have supervisees"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">6</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER_ACCEPTED_TOS"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"User accepted ToS"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Basic role needed to access most of the API elements"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
</span>}
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">teams</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"HR"</span></span>,
"<span class="hljs-attribute">organization</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Loopline Systems GmbH"</span></span>,
"<span class="hljs-attribute">logo</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"d47965e73e19a1ef8b5eeb0f2318a982.png"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/d47965e73e19a1ef8b5eeb0f2318a982.png"</span>
</span>}</span>,
"<span class="hljs-attribute">systemEmail</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">globalFeedbackPeriodDuration</span>": <span class="hljs-value"><span class="hljs-string">"4 months"</span></span>,
"<span class="hljs-attribute">globalFeedbackOpenDuration</span>": <span class="hljs-value"><span class="hljs-string">"1 month"</span></span>,
"<span class="hljs-attribute">refreshTimeouts</span>": <span class="hljs-value">{
"<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">30000</span></span>,
"<span class="hljs-attribute">user</span>": <span class="hljs-value"><span class="hljs-number">18000</span>
</span>}</span>,
"<span class="hljs-attribute">initialSetupDone</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">4</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Strategy"</span></span>,
"<span class="hljs-attribute">organization</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Loopline Systems GmbH"</span></span>,
"<span class="hljs-attribute">logo</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"d47965e73e19a1ef8b5eeb0f2318a982.png"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/d47965e73e19a1ef8b5eeb0f2318a982.png"</span>
</span>}</span>,
"<span class="hljs-attribute">systemEmail</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">globalFeedbackPeriodDuration</span>": <span class="hljs-value"><span class="hljs-string">"4 months"</span></span>,
"<span class="hljs-attribute">globalFeedbackOpenDuration</span>": <span class="hljs-value"><span class="hljs-string">"1 month"</span></span>,
"<span class="hljs-attribute">refreshTimeouts</span>": <span class="hljs-value">{
"<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">30000</span></span>,
"<span class="hljs-attribute">user</span>": <span class="hljs-value"><span class="hljs-number">18000</span>
</span>}</span>,
"<span class="hljs-attribute">initialSetupDone</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Project Mullins"</span></span>,
"<span class="hljs-attribute">organization</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Loopline Systems GmbH"</span></span>,
"<span class="hljs-attribute">logo</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"d47965e73e19a1ef8b5eeb0f2318a982.png"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/d47965e73e19a1ef8b5eeb0f2318a982.png"</span>
</span>}</span>,
"<span class="hljs-attribute">systemEmail</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">globalFeedbackPeriodDuration</span>": <span class="hljs-value"><span class="hljs-string">"4 months"</span></span>,
"<span class="hljs-attribute">globalFeedbackOpenDuration</span>": <span class="hljs-value"><span class="hljs-string">"1 month"</span></span>,
"<span class="hljs-attribute">refreshTimeouts</span>": <span class="hljs-value">{
"<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">30000</span></span>,
"<span class="hljs-attribute">user</span>": <span class="hljs-value"><span class="hljs-number">18000</span>
</span>}</span>,
"<span class="hljs-attribute">initialSetupDone</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">7</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Finance"</span></span>,
"<span class="hljs-attribute">organization</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Loopline Systems GmbH"</span></span>,
"<span class="hljs-attribute">logo</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"d47965e73e19a1ef8b5eeb0f2318a982.png"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/d47965e73e19a1ef8b5eeb0f2318a982.png"</span>
</span>}</span>,
"<span class="hljs-attribute">systemEmail</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">globalFeedbackPeriodDuration</span>": <span class="hljs-value"><span class="hljs-string">"4 months"</span></span>,
"<span class="hljs-attribute">globalFeedbackOpenDuration</span>": <span class="hljs-value"><span class="hljs-string">"1 month"</span></span>,
"<span class="hljs-attribute">refreshTimeouts</span>": <span class="hljs-value">{
"<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">30000</span></span>,
"<span class="hljs-attribute">user</span>": <span class="hljs-value"><span class="hljs-number">18000</span>
</span>}</span>,
"<span class="hljs-attribute">initialSetupDone</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">5</span>
</span>}
]</span>,
"<span class="hljs-attribute">locale</span>": <span class="hljs-value"><span class="hljs-string">"de_DE"</span></span>,
"<span class="hljs-attribute">tourSectionsMissing</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"app.me.trainings"</span></span>,
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span>
</span>}
]</span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#b638a5792d49df89f131fe71890c49ad" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="b638a5792d49df89f131fe71890c49ad" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#28804eb0d351756a8d821844fe365c57" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="28804eb0d351756a8d821844fe365c57" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section><section id="user-user-post" class="panel panel-success"><div data-toggle="collapse" data-target="#user-user-post .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Create a new user</span></div><div style="float:left"><a href="#page:user,header:user-user-post" class="btn btn-xs btn-success">POST</a></div><div style="overflow:hidden"><code>/users/{id}</code></div></div><div class="panel content-group collapse"><div class="panel-body"><p>@see
* <a href="http://developer.loopline-systems.com/index.html#page:application,header:application-locale-list">/application/locales</a>
* request to get a list of possible locales</p>
</div><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>email</dt><dd><code>string (\s+)</code> <span class="required">(required)</span> <p>The email of the user</p>
</dd><dt>locale</dt><dd><code>string (\s+)</code> <span class="required">(required)</span> <p>The locale of the user</p>
</dd><dt>firstname</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>The firstname of the user</p>
</dd><dt>lastname</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>The lastname of the user</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#f21383d65d4853aa586e7d8aed21743a" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="f21383d65d4853aa586e7d8aed21743a" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br/></code></pre><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span></span>,
"<span class="hljs-attribute">email</span>":<span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">locale</span>": <span class="hljs-value"><span class="hljs-string">"de_DE"</span>
</span>}
</code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">POST : /users</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users \<br/>-X POST \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>" \<br />-H "Content-Type: application/json" \<br />-d '{
"firstname": "Susann",
"lastname": "Riley",
"email":"[email protected]",
"locale": "de_DE"
}'</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#00790472a38446d27acf825533d03c9f" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>201</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="00790472a38446d27acf825533d03c9f" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">21</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"https://ec3660afbaec0812cdb5-83af784216914eb78a3907e564e823b0.ssl.cf3.rackcdn.com/default_user.png"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"12-06-2015"</span></span>,
"<span class="hljs-attribute">confirmationToken</span>": <span class="hljs-value"><span class="hljs-string">"87e4c3e4af9d04d5d2f5631ec06ac16ca5091ac7"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}
</code></pre><div class="description"><p>Returned when created</p>
</div></li><li data-toggle="collapse" data-target="#a0395437f43a8e728ca238e9d90865a7" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>400</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="a0395437f43a8e728ca238e9d90865a7" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when the request content is malformed</p>
</div></li><li data-toggle="collapse" data-target="#f7203801ba721039ec5ba63046bbcf34" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="f7203801ba721039ec5ba63046bbcf34" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#0a8d5bc3b0d70f6b35b4b057a5d87b9b" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="0a8d5bc3b0d70f6b35b4b057a5d87b9b" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li><li data-toggle="collapse" data-target="#d9609edff7e996195105df4af3b1ffdb" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>409</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="d9609edff7e996195105df4af3b1ffdb" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when organization initialSetup not done</p>
</div></li></ul></div></section><section id="user-user-patch" class="panel panel-warning"><div data-toggle="collapse" data-target="#user-user-patch .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Update a single user</span></div><div style="float:left"><a href="#page:user,header:user-user-patch" class="btn btn-xs btn-warning">PATCH</a></div><div style="overflow:hidden"><code>/users/{id}</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the user to be changed</p>
</dd><dt>email</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>The new email of the user</p>
</dd><dt>locale</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>The new locale of the user</p>
</dd><dt>firstname</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>The new firstname of the user</p>
</dd><dt>lastname</dt><dd><code>string (\s+)</code> <span>(optional)</span> <p>The new lastname of the user</p>
</dd><dt>position</dt><dd><code>bool</code> <span>(optional)</span> <p>Does the user accept the TOS</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#2e0729ade3f0b41b08bd79f1f89c0f33" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="2e0729ade3f0b41b08bd79f1f89c0f33" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br/></code></pre><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span>
</span>}
</code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">PATCH : /users/{id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id> \<br/>-X PATCH \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>" \<br />-H "Content-Type: application/json" \<br />-d '{
"firstname": "Susann",
"lastname": "Riley"
}'</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#7ee283e1a432c7aa6e1e741b437206b7" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="7ee283e1a432c7aa6e1e741b437206b7" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Rilay"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"Customer Success Agent"</span></span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"08-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#5fb948f6b8044df372edb2fa67d4cc9d" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>400</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="5fb948f6b8044df372edb2fa67d4cc9d" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when the request content is malformed</p>
</div></li><li data-toggle="collapse" data-target="#46d61499dc9f756ac74c212af6debb4f" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="46d61499dc9f756ac74c212af6debb4f" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#50fd9459d3671b2c5f1b7bcb50db72f8" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="50fd9459d3671b2c5f1b7bcb50db72f8" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section><h4 id="user-supervisee-list">Supervisee List <a href="#page:user,header:user-supervisee-list"><i class="fa fa-link"></i></a></h4><section id="user-supervisee-list-get" class="panel panel-info"><div data-toggle="collapse" data-target="#user-supervisee-list-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get all supervisees of a user</span></div><div style="float:left"><a href="#page:user,header:user-supervisee-list-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/users/{id}/supervisees</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the user</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#0df734c640368bd658d2c88fa6fc88e1" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="0df734c640368bd658d2c88fa6fc88e1" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /users/{id}/supervisees</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id>/supervisees \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#9415890c4e6ba82cf40a8e1f41930590" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="9415890c4e6ba82cf40a8e1f41930590" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Catrina"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Carnahan"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CFO"</span></span>,
"<span class="hljs-attribute">recommendable</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">teams</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Project Mullins"</span></span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">6</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Finance"</span></span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">3</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Efficiency 440"</span></span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">3</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">6</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"UI/UX"</span></span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">4</span>
</span>}
]</span>,
"<span class="hljs-attribute">activeFeedbackPeriod</span>": <span class="hljs-value">{
"<span class="hljs-attribute">user</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">feedbackPeriod</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">start</span>": <span class="hljs-value"><span class="hljs-string">"2015-02-23"</span></span>,
"<span class="hljs-attribute">end</span>": <span class="hljs-value"><span class="hljs-string">"2015-06-22"</span></span>,
"<span class="hljs-attribute">open</span>": <span class="hljs-value"><span class="hljs-string">"2015-05-23"</span>
</span>}</span>,
"<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"prepared"</span></span>,
"<span class="hljs-attribute">statusSupervisee</span>": <span class="hljs-value"><span class="hljs-string">"prepared"</span></span>,
"<span class="hljs-attribute">statusSupervisor</span>": <span class="hljs-value"><span class="hljs-string">"prepared"</span></span>,
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">44</span>
</span>}</span>,
"<span class="hljs-attribute">currentFeedbackPeriod</span>": <span class="hljs-value">{
"<span class="hljs-attribute">user</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">feedbackPeriod</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">start</span>": <span class="hljs-value"><span class="hljs-string">"2015-02-23"</span></span>,
"<span class="hljs-attribute">end</span>": <span class="hljs-value"><span class="hljs-string">"2015-06-22"</span></span>,
"<span class="hljs-attribute">open</span>": <span class="hljs-value"><span class="hljs-string">"2015-05-23"</span>
</span>}</span>,
"<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"prepared"</span></span>,
"<span class="hljs-attribute">statusSupervisee</span>": <span class="hljs-value"><span class="hljs-string">"prepared"</span></span>,
"<span class="hljs-attribute">statusSupervisor</span>": <span class="hljs-value"><span class="hljs-string">"prepared"</span></span>,
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">44</span>
</span>}</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"08-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}
]
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#3f4fb83aabc941fd951addf0b9f7dffc" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="3f4fb83aabc941fd951addf0b9f7dffc" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#aa9e5bf8048b09aebc32cbfc209cd513" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>403</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="aa9e5bf8048b09aebc32cbfc209cd513" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not allowed</p>
</div></li><li data-toggle="collapse" data-target="#a5a6fe6ac0f2385cfffa90924f444508" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="a5a6fe6ac0f2385cfffa90924f444508" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section><h4 id="user-supervisor">Supervisor <a href="#page:user,header:user-supervisor"><i class="fa fa-link"></i></a></h4><section id="user-supervisor-post" class="panel panel-success"><div data-toggle="collapse" data-target="#user-supervisor-post .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Assign a supervisor to a user</span></div><div style="float:left"><a href="#page:user,header:user-supervisor-post" class="btn btn-xs btn-success">POST</a></div><div style="overflow:hidden"><code>/users/{id}/supervisor/{supervisor_id}</code></div></div><div class="panel content-group collapse"><div class="panel-body"><p>Assign a supervisor to a user. You must be Admin to access this
* resource</p>
</div><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the supervisee</p>
</dd><dt>supervisor_id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the supervisor</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#7a0a3d5312b7c04305d8a3e11e653331" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="7a0a3d5312b7c04305d8a3e11e653331" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">POST : /users/{id}/supervisor/{supervisor_id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id>/supervisor/<supervisor_id> \<br/>-X POST \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#a1f5b32ccc08140b9424924645af36e3" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>201</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="a1f5b32ccc08140b9424924645af36e3" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when created</p>
</div></li><li data-toggle="collapse" data-target="#6c71cd2e1f0dc6072678810bf50a1772" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>400</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="6c71cd2e1f0dc6072678810bf50a1772" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when the request content is malformed</p>
</div></li><li data-toggle="collapse" data-target="#32f890c3f49c4a54c9bb415481d571cb" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="32f890c3f49c4a54c9bb415481d571cb" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#9fafed884f406e10d22fdc511f258d1f" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>403</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="9fafed884f406e10d22fdc511f258d1f" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not allowed</p>
</div></li><li data-toggle="collapse" data-target="#91562f6c72a9d4b242c65d3d613fcb8c" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="91562f6c72a9d4b242c65d3d613fcb8c" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section><section id="user-supervisor-delete" class="panel panel-danger"><div data-toggle="collapse" data-target="#user-supervisor-delete .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Remove a supervisee from a supervisor</span></div><div style="float:left"><a href="#page:user,header:user-supervisor-delete" class="btn btn-xs btn-danger">DELETE</a></div><div style="overflow:hidden"><code>/users/{id}/supervisor/{supervisor_id}</code></div></div><div class="panel content-group collapse"><div class="panel-body"><p>Remove a supervisee from a supervisor. You need to be
* supervisor of the user or admin</p>
</div><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the supervisee</p>
</dd><dt>supervisor_id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the supervisor</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#3aa0276518352ccc08ecb20c78db9db8" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="3aa0276518352ccc08ecb20c78db9db8" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">DELETE : /users/{id}/supervisor/{supervisor_id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id>/supervisor/<supervisor_id> \<br/>-X DELETE \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#518ae0992efc12902400947a2d9d8de8" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>204</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="518ae0992efc12902400947a2d9d8de8" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when user deleted</p>
</div></li><li data-toggle="collapse" data-target="#385b6c68efe61effa2302dcb13275290" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="385b6c68efe61effa2302dcb13275290" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#da3c649047c497d1f163a7c38006a14e" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>403</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="da3c649047c497d1f163a7c38006a14e" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authorized</p>
</div></li><li data-toggle="collapse" data-target="#b742cd498e5b5f41d5a5556b0bb54ba6" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="b742cd498e5b5f41d5a5556b0bb54ba6" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when supervisee not found</p>
</div></li></ul></div></section><h4 id="user-user-image">User Image <a href="#page:user,header:user-user-image"><i class="fa fa-link"></i></a></h4><section id="user-user-image-post" class="panel panel-success"><div data-toggle="collapse" data-target="#user-user-image-post .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Update the profile image of a user</span></div><div style="float:left"><a href="#page:user,header:user-user-image-post" class="btn btn-xs btn-success">POST</a></div><div style="overflow:hidden"><code>/users/{id}/image</code></div></div><div class="panel content-group collapse"><div class="panel-body"><p>Update the profile image of a user. The image is submitted in
* the request body</p>
</div><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the user</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#851bd6d8d84e8345d6d4cd397474dcec" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="851bd6d8d84e8345d6d4cd397474dcec" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">multipart/form-data; boundary=---BOUNDARY</span><br/><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">POST : /users/{id}/image</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id>/image \<br/>-X POST \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>" \ <br />-F name=file -F [email protected]</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#9d4c65dbceeeb6fa351b81f27221dc18" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>201</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="9d4c65dbceeeb6fa351b81f27221dc18" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">19</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://example.com/user-image.jpeg"</span>
</span>}
</code></pre><div class="description"><p>Returned when created</p>
</div></li><li data-toggle="collapse" data-target="#1c083f30cecf50f668e3ca65fc7023bf" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>400</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="1c083f30cecf50f668e3ca65fc7023bf" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when the request content is malformed</p>
</div></li><li data-toggle="collapse" data-target="#46aa2abafcfbca51dc06e21bc1a38be0" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="46aa2abafcfbca51dc06e21bc1a38be0" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#dd7cb886642e8a705ac4071cabf9a500" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>403</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="dd7cb886642e8a705ac4071cabf9a500" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authorized</p>
</div></li></ul></div></section><section id="user-user-image-delete" class="panel panel-danger"><div data-toggle="collapse" data-target="#user-user-image-delete .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Delete the profile image of a user</span></div><div style="float:left"><a href="#page:user,header:user-user-image-delete" class="btn btn-xs btn-danger">DELETE</a></div><div style="overflow:hidden"><code>/users/{id}/image</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the user</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#b6a7eb623f97f534944893f0486fea5f" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="b6a7eb623f97f534944893f0486fea5f" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">DELETE : /users/{id}/image</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id>/image \<br/>-X DELETE \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#e120fdcef9f627ed183124f2d08a8a88" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="e120fdcef9f627ed183124f2d08a8a88" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CEO"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Active user"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}
]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Christian"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Miller"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/christian.miller.jpg"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CEO"</span></span>,
"<span class="hljs-attribute">roles</span>": <span class="hljs-value">[]</span>,
"<span class="hljs-attribute">supervisor</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">recommendable</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">teams</span>": <span class="hljs-value">[]</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"08-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">recommendable</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">teams</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"HR"</span></span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>}
]</span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">acceptedTOS</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"08-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}
</code></pre><div class="description"><p>Returned when deleted, including user entity</p>
</div></li><li data-toggle="collapse" data-target="#cf76aa82f550e3a7411f08845aa70c3f" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="cf76aa82f550e3a7411f08845aa70c3f" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#d46b376c93f2b493248648495735c696" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>403</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="d46b376c93f2b493248648495735c696" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authorized</p>
</div></li><li data-toggle="collapse" data-target="#5f57e19e2fefdfffcc2ca2a60ee527ec" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="5f57e19e2fefdfffcc2ca2a60ee527ec" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section></div></div><a href="#page:role" class="btn btn-default pull-right">Next <i class="fa fa-arrow-circle-right"></i></a><a href="#page:application" class="btn btn-default"><i class="fa fa-arrow-circle-left"></i> Previous</a><div class="clearfix"></div><hr/></div><div data-bind="visible: page() == 'role', style: {marginTop: page() == 'role' ? '38px' : ''}"><div class="panel panel-default"><div class="panel-heading"><h3 id="role">Role <a href="#page:role"><i class="fa fa-link"></i></a></h3></div><div class="panel-body"><h4 id="role-role-list">Role List <a href="#page:role,header:role-role-list"><i class="fa fa-link"></i></a></h4><section id="role-role-list-get" class="panel panel-info"><div data-toggle="collapse" data-target="#role-role-list-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get all roles</span></div><div style="float:left"><a href="#page:role,header:role-role-list-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/roles</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>filter</dt><dd><code>string (\w+)</code> <span>(optional)</span> <p>The filter for the roles</p>
<p><strong>Choices: </strong><code>api-roles</code> </p></dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#5ecf1219a48ed1cb70f377a84d605e2f" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="5ecf1219a48ed1cb70f377a84d605e2f" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /roles</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/roles \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#6142fd62203157a1b08e1551c5e92b5e" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="6142fd62203157a1b08e1551c5e92b5e" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_USER"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Active user"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_ADMIN"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"System admin"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">7</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_CAN_BE_SUPERVISOR"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Can have direct reports"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}
]
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#0e45c48a6617d1bccd196361866ec772" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="0e45c48a6617d1bccd196361866ec772" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li></ul></div></section><h4 id="role-role">Role <a href="#page:role,header:role-role"><i class="fa fa-link"></i></a></h4><section id="role-role-get" class="panel panel-info"><div data-toggle="collapse" data-target="#role-role-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get a single role</span></div><div style="float:left"><a href="#page:role,header:role-role-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/roles/{id}</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the role</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#2aba16014e97cd622762c4d82c3c30ed" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="2aba16014e97cd622762c4d82c3c30ed" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /roles/{id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/roles/<id> \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#4f64426a0ad715ddee45d57c6f31fb9f" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="4f64426a0ad715ddee45d57c6f31fb9f" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">4</span></span>,
"<span class="hljs-attribute">role</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_ADMIN"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"System admin"</span></span>,
"<span class="hljs-attribute">toggleable</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#a5f98db6db4e6a2b3fb0a78c649ae42c" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="a5f98db6db4e6a2b3fb0a78c649ae42c" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#b0413a7bf0a56a7c6eecc7893d2fa40b" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="b0413a7bf0a56a7c6eecc7893d2fa40b" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section><h4 id="role-role-membership">Role Membership <a href="#page:role,header:role-role-membership"><i class="fa fa-link"></i></a></h4><section id="role-role-membership-post" class="panel panel-success"><div data-toggle="collapse" data-target="#role-role-membership-post .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Add a role to a user</span></div><div style="float:left"><a href="#page:role,header:role-role-membership-post" class="btn btn-xs btn-success">POST</a></div><div style="overflow:hidden"><code>/users/{id}/role/{role_id}</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the user</p>
</dd><dt>role_id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the Role</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#695a4c4748502d016594325a26946e01" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="695a4c4748502d016594325a26946e01" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">POST : /users/{id}/role/{role_id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id>/role/<role_id> \<br/>-X POST \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#ebb5df72d3d2d9ed2487e0c5a6b0b590" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>201</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="ebb5df72d3d2d9ed2487e0c5a6b0b590" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>":<span class="hljs-value"><span class="hljs-number">18</span></span>,
"<span class="hljs-attribute">locale</span>":<span class="hljs-value"><span class="hljs-string">"en_US"</span>
</span>}
</code></pre><div class="description"><p>Returned when created</p>
</div></li><li data-toggle="collapse" data-target="#e77af80e515e1d705fb96eb98bb9719f" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="e77af80e515e1d705fb96eb98bb9719f" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#136b855e9850e6963b472f829ab5eb99" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>403</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="136b855e9850e6963b472f829ab5eb99" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not allowed</p>
</div></li><li data-toggle="collapse" data-target="#3f1a1defeef5fd49eaf7ef302ef08a3a" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="3f1a1defeef5fd49eaf7ef302ef08a3a" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section><section id="role-role-membership-delete" class="panel panel-danger"><div data-toggle="collapse" data-target="#role-role-membership-delete .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Remove a role from a user</span></div><div style="float:left"><a href="#page:role,header:role-role-membership-delete" class="btn btn-xs btn-danger">DELETE</a></div><div style="overflow:hidden"><code>/users/{id}/role/{role_id}</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the user</p>
</dd><dt>role_id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the Role</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#f5d088e1a539ffb6cbe4dd1e6c5caba3" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="f5d088e1a539ffb6cbe4dd1e6c5caba3" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">DELETE : /users/{id}/role/{role_id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/users/<id>/role/<role_id> \<br/>-X DELETE \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#26f71de45a30351ffe8a8ab6c7a0d7eb" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>204</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="26f71de45a30351ffe8a8ab6c7a0d7eb" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when role has been deleted</p>
</div></li><li data-toggle="collapse" data-target="#671f7eea899ae44017124ccbc7d93597" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="671f7eea899ae44017124ccbc7d93597" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#b4aa92603a4ba693daaf54c52059c4b5" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>403</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="b4aa92603a4ba693daaf54c52059c4b5" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not allowed</p>
</div></li><li data-toggle="collapse" data-target="#b8e554223f589276d78cc071bf882e83" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="b8e554223f589276d78cc071bf882e83" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not found</p>
</div></li></ul></div></section></div></div><a href="#page:team" class="btn btn-default pull-right">Next <i class="fa fa-arrow-circle-right"></i></a><a href="#page:user" class="btn btn-default"><i class="fa fa-arrow-circle-left"></i> Previous</a><div class="clearfix"></div><hr/></div><div data-bind="visible: page() == 'team', style: {marginTop: page() == 'team' ? '38px' : ''}"><div class="panel panel-default"><div class="panel-heading"><h3 id="team">Team <a href="#page:team"><i class="fa fa-link"></i></a></h3></div><div class="panel-body"><h4 id="team-team">Team <a href="#page:team,header:team-team"><i class="fa fa-link"></i></a></h4><section id="team-team-get" class="panel panel-info"><div data-toggle="collapse" data-target="#team-team-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get all teams</span></div><div style="float:left"><a href="#page:team,header:team-team-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/teams</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>members</dt><dd><code>string</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>false</span></span> <p>Add Members to response</p>
</dd><dt>filter.user</dt><dd><code>integer (\d+)</code> <span>(optional)</span> <p>Filter by user</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#eba8c3555ea4819ca6151df675031bac" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="eba8c3555ea4819ca6151df675031bac" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /teams</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/teams \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#161b4c3fc8dcdd1de3cc12f4945f7a85" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="161b4c3fc8dcdd1de3cc12f4945f7a85" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"HR"</span></span>,
"<span class="hljs-attribute">documents</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">teamlead</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"cee9262a8929dfe7584a98548f70f948.jpeg"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/cee9262a8929dfe7584a98548f70f948.jpeg"</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">13795</span></span>,
"<span class="hljs-attribute">mimeType</span>": <span class="hljs-value"><span class="hljs-string">"image/jpeg"</span></span>,
"<span class="hljs-attribute">createdAt</span>": <span class="hljs-value"><span class="hljs-string">"2015-06-18T08:28:10+0000"</span></span>,
"<span class="hljs-attribute">originalName</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CEO"</span></span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">createdAt</span>": <span class="hljs-value"><span class="hljs-string">"2015-06-18T08:26:09+0000"</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Strategy"</span></span>,
"<span class="hljs-attribute">documents</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">teamlead</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Riley"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"cee9262a8929dfe7584a98548f70f948.jpeg"</span></span>,
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/cee9262a8929dfe7584a98548f70f948.jpeg"</span></span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">13795</span></span>,
"<span class="hljs-attribute">mimeType</span>": <span class="hljs-value"><span class="hljs-string">"image/jpeg"</span></span>,
"<span class="hljs-attribute">createdAt</span>": <span class="hljs-value"><span class="hljs-string">"2015-06-18T08:28:10+0000"</span></span>,
"<span class="hljs-attribute">originalName</span>": <span class="hljs-value"><span class="hljs-string">"Susann"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-string">"CEO"</span></span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">createdAt</span>": <span class="hljs-value"><span class="hljs-string">"2015-06-18T08:26:09+0000"</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>}
]
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#329dfa70f3cd486ba7478f978d51f212" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="329dfa70f3cd486ba7478f978d51f212" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li></ul></div></section><section id="team-team-get" class="panel panel-info"><div data-toggle="collapse" data-target="#team-team-get .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Get a single team</span></div><div style="float:left"><a href="#page:team,header:team-team-get" class="btn btn-xs btn-primary">GET</a></div><div style="overflow:hidden"><code>/teams</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the team</p>
</dd><dt>members</dt><dd><code>string</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>false</span></span> <p>Add Members to response</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#adf6eb99bf5e5590679a647de7aafded" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="adf6eb99bf5e5590679a647de7aafded" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/></code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">GET : /teams/{id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/teams/<id> \<br/>-X GET \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>"</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#c863942761faec640f7713faacb2a607" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="c863942761faec640f7713faacb2a607" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">12</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Loopline Systems Team"</span></span>,
"<span class="hljs-attribute">documents</span>": <span class="hljs-value">[
]</span>,
"<span class="hljs-attribute">isLead</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">teamlead</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">firstname</span>": <span class="hljs-value"><span class="hljs-string">"The"</span></span>,
"<span class="hljs-attribute">lastname</span>": <span class="hljs-value"><span class="hljs-string">"Admin"</span></span>,
"<span class="hljs-attribute">image</span>": <span class="hljs-value">{
"<span class="hljs-attribute">webPath</span>": <span class="hljs-value"><span class="hljs-string">"https://ec3660afbaec0812cdb5-83af784216914eb78a3907e564e823b0.ssl.cf3.rackcdn.com/default_user.png"</span>
</span>}</span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"[email protected]"</span></span>,
"<span class="hljs-attribute">position</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">active</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">createdAt</span>": <span class="hljs-value"><span class="hljs-string">"2015-06-18T08:25:59+0000"</span></span>,
"<span class="hljs-attribute">activatedAt</span>": <span class="hljs-value"><span class="hljs-string">"18-06-2015"</span></span>,
"<span class="hljs-attribute">deactivatedAt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">lastPasswordResetByAdmin</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">size</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>}
</code></pre><div class="description"><p>Returned when successful</p>
</div></li><li data-toggle="collapse" data-target="#74eaafbc5a24d4e6a179cb46d5ed2ce9" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>401</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="74eaafbc5a24d4e6a179cb46d5ed2ce9" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when not authenticated</p>
</div></li><li data-toggle="collapse" data-target="#309d78a082f6eb83c5fb4ebd445e98fa" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>404</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="309d78a082f6eb83c5fb4ebd445e98fa" role="response" class="list-group-item panel-collapse collapse"><div class="description"><p>Returned when team not found</p>
</div></li></ul></div></section><section id="team-team-patch" class="panel panel-warning"><div data-toggle="collapse" data-target="#team-team-patch .content-group" class="panel-heading"><div style="margin-bottom: 10px;"><span>Update a single team</span></div><div style="float:left"><a href="#page:team,header:team-team-patch" class="btn btn-xs btn-warning">PATCH</a></div><div style="overflow:hidden"><code>/teams</code></div></div><div class="panel content-group collapse"><ul class="list-group"><li class="list-group-item bg-default"><strong>Parameters</strong></li><li class="list-group-item"><dl class="dl-horizontal"><dt>id</dt><dd><code>integer (\d+)</code> <span class="required">(required)</span> <p>The id of the team</p>
</dd><dt>name</dt><dd><code>string (\w+)</code> <span class="required">(required)</span> <p>The new name of the team</p>
</dd></dl></li></ul><ul class="list-group"><li data-toggle="collapse" data-target="#7a2ed850b025ce93e6e6e2f93d543296" role="requestTrigger" class="list-group-item collapsed"><strong>Request</strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="7a2ed850b025ce93e6e6e2f93d543296" role="request" class="list-group-item panel-collapse collapse"><h5>Headers</h5><pre><code><span class="hljs-attribute">X-Loopline-Client</span>: <span class="hljs-string"><CLIENT_ID></span><br/><span class="hljs-attribute">X-Api-Key</span>: <span class="hljs-string"><API_KEY></span><br/><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br/></code></pre><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"HR"</span>
</span>}
</code></pre><div class="description"><p>Example:</p>
<div class="terminal">
<p class="head">PATCH : /teams/{id}</p>
<ul class="body">
<li>curl https://api.loopline-systems.com/teams/<id> \<br/>-X PATCH \<br />-H "X-Loopline-Client: <CLIENT_ID>" \<br />-H "X-Api-Key: <API_KEY>" \<br />-H "Content-Type: application/json" \<br />-d '{
"name": "HR"
}'</li>
</ul>
</div>
</div></li><li data-toggle="collapse" data-target="#b4e134201607d86044bb55a2248edea8" role="responseTrigger" class="list-group-item collapsed"><strong>Response <code>200</code></strong><a class="pull-right"><span class="closed">Show</span><span class="open">Hide</span></a></li><li id="b4e134201607d86044bb55a2248edea8" role="response" class="list-group-item panel-collapse collapse"><h5>Body</h5><pre><code>{
<span class="hljs-string">"id"</span>: <span class="hljs-number">1</span>,
<span class="hljs-string">"name"</span>: <span class="hljs-string">"HR"</span>,
<span class="hljs-string">"users"</span>: [
{
<span class="hljs-string">"id"</span>: <span class="hljs-number">2</span>,
<span class="hljs-string">"username"</span>: <span class="hljs-string">"[email protected],
"</span>firstname<span class="hljs-string">": "</span>Susann<span class="hljs-string">",
"</span>lastname<span class="hljs-string">": "</span>Riley<span class="hljs-string">",
"</span>image<span class="hljs-string">": {
"</span>id<span class="hljs-string">": 2,
"</span>name<span class="hljs-string">": "</span><span class="hljs-string">",
"w</span>ebPath<span class="hljs-string">": "</span>http:<span class="hljs-comment">//static.helen.dev/tal-lon-cdn/"</span>
},
<span class="hljs-string">"email"</span>: <span class="hljs-string">"[email protected]"</span>,
<span class="hljs-string">"position"</span>: <span class="hljs-string">"CEO"</span>,
<span class="hljs-string">"active"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">"activatedAt"</span>: <span class="hljs-string">"08-06-2015"</span>,
<span class="hljs-string">"deactivatedAt"</span>: <span class="hljs-literal">null</span>,
<span class="hljs-string">"lastPasswordResetByAdmin"</span>: <span class="hljs-literal">null</span>
},
{
<span class="hljs-string">"id"</span>: <span class="hljs-number">18</span>,
<span class="hljs-string">"username"</span>: <span class="hljs-string">"[email protected]"</span>,
<span class="hljs-string">"firstname"</span>: <span class="hljs-string">"Alex"</span>,
<span class="hljs-string">"lastname"</span>: <span class="hljs-string">"Millner"</span>,
<span class="hljs-string">"image"</span>: {
<span class="hljs-string">"id"</span>: <span class="hljs-number">18</span>,
<span class="hljs-string">"name"</span>: <span class="hljs-string">""</span>,
<span class="hljs-string">"webPath"</span>: <span class="hljs-string">"http://static.helen.dev/tal-lon-cdn/"</span>
},
<span class="hljs-string">"email"</span>: <span class="hljs-string">"[email protected]"</span>,