-
Notifications
You must be signed in to change notification settings - Fork 18
/
apiary.apib
829 lines (744 loc) · 23.7 KB
/
apiary.apib
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
--- ExpressionEngine Open API v0.4 ---
---
The Open API is an ExpressionEngine add-on that brings front-end CRUD capability to websites.
---
--
Authentication
--
Authenticate member with username and get a session_id that can be used for requests that require member authentication
| Request parameters | | |
| :------------- | ------------- | ------------- |
| username | The username of the member to authenticate | required |
| password | The password of the member to authenticate | required |
POST /authenticate_username
> Content-Type: application/x-www-form-urlencoded
username=michael&password=abc123
< 200
< Content-Type: application/json
{
"session_id": "87b1bc8c82c40214d8682c9cbada3e91f2df6b98",
"member_id": "1",
"username": "testuser",
"screen_name": "Test User"
}
Authenticate member with email and get a session_id that can be used for requests that require member authentication
| Request parameters | | |
| :------------- | ------------- | ------------- |
| email | The email of the member to authenticate | required |
| password | The password of the member to authenticate | required |
POST /authenticate_email
> Content-Type: application/x-www-form-urlencoded
[email protected]&password=abc123
< 200
< Content-Type: application/json
{
"session_id": "87b1bc8c82c40214d8682c9cbada3e91f2df6b98",
"member_id": "1",
"username": "testuser",
"screen_name": "Test User"
}
Authenticate member with id and get a session_id that can be used for requests that require member authentication
| Request parameters | | |
| :------------- | ------------- | ------------- |
| member_id | The id of the member to authenticate | required |
| password | The password of the member to authenticate | required |
POST /authenticate_member_id
> Content-Type: application/x-www-form-urlencoded
member_id=1&password=abc123
< 200
< Content-Type: application/json
{
"session_id": "87b1bc8c82c40214d8682c9cbada3e91f2df6b98",
"member_id": "1",
"username": "testuser",
"screen_name": "Test User"
}
--
Channels
--
Get channel
\* Requires authentication if specified in settings
| Request parameters | | |
| :------------- | ------------- | ------------- |
| channel_id | The id of the channel to get | required |
GET /get_channel?channel_id=1
< 200
< Content-Type: application/json
[
{
"channel_id": "1",
"site_id": "1",
"channel_name": "channel_name",
"channel_title": "Channel",
"channel_url": "http:\/\/www.ee2.com",
"channel_description": "",
"channel_lang": "en",
"total_entries": "41",
"total_comments": "33",
"last_entry_date": "1360205184",
"last_comment_date": "1350228795",
"cat_group": "2",
"status_group": null,
"deft_status": "",
"field_group": "1",
"search_excerpt": null,
"deft_category": "",
"deft_comments": "y",
"channel_require_membership": "y",
"channel_max_chars": null,
"channel_html_formatting": "all",
"channel_allow_img_urls": "y",
"channel_auto_link_urls": "y",
"channel_notify": "n",
"channel_notify_emails": "",
"comment_url": "",
"comment_system_enabled": "y",
"comment_require_membership": "n",
"comment_use_captcha": "n",
"comment_moderate": "n",
"comment_max_chars": "5000",
"comment_timelock": "0",
"comment_require_email": "n",
"comment_text_formatting": "xhtml",
"comment_html_formatting": "safe",
"comment_allow_img_urls": "n",
"comment_auto_link_urls": "y",
"comment_notify": "n",
"comment_notify_authors": "n",
"comment_notify_emails": "",
"comment_expiration": "0",
"search_results_url": "",
"ping_return_url": "",
"show_button_cluster": "y",
"rss_url": "",
"enable_versioning": "n",
"max_revisions": "10",
"default_entry_title": "",
"url_title_prefix": "",
"live_look_template": "0"
}
]
Get channels
\* Requires authentication if specified in settings
| Request parameters | | |
| :------------- | ------------- | ------------- |
| site_id | The id of the site to get channels from | optional |
GET /get_channels?site_id=1
< 200
< Content-Type: application/json
[
{
"channel_id": "1",
"site_id": "1",
"channel_name": "channel_name",
"channel_title": "Channel",
"channel_url": "http:\/\/www.ee2.com",
"channel_description": "",
"channel_lang": "en",
"total_entries": "41",
"total_comments": "33",
"last_entry_date": "1360205184",
"last_comment_date": "1350228795",
"cat_group": "2",
"status_group": null,
"deft_status": "",
"field_group": "1",
"search_excerpt": null,
"deft_category": "",
"deft_comments": "y",
"channel_require_membership": "y",
"channel_max_chars": null,
"channel_html_formatting": "all",
"channel_allow_img_urls": "y",
"channel_auto_link_urls": "y",
"channel_notify": "n",
"channel_notify_emails": "",
"comment_url": "",
"comment_system_enabled": "y",
"comment_require_membership": "n",
"comment_use_captcha": "n",
"comment_moderate": "n",
"comment_max_chars": "5000",
"comment_timelock": "0",
"comment_require_email": "n",
"comment_text_formatting": "xhtml",
"comment_html_formatting": "safe",
"comment_allow_img_urls": "n",
"comment_auto_link_urls": "y",
"comment_notify": "n",
"comment_notify_authors": "n",
"comment_notify_emails": "",
"comment_expiration": "0",
"search_results_url": "",
"ping_return_url": "",
"show_button_cluster": "y",
"rss_url": "",
"enable_versioning": "n",
"max_revisions": "10",
"default_entry_title": "",
"url_title_prefix": "",
"live_look_template": "0"
},
{
"channel_id": "2",
"site_id": "1",
"channel_name": "channel_name",
"channel_title": "Channel",
"channel_url": "http:\/\/www.ee2.com",
"channel_description": "",
"channel_lang": "en",
"total_entries": "41",
"total_comments": "33",
"last_entry_date": "1360205184",
"last_comment_date": "1350228795",
"cat_group": "2",
"status_group": null,
"deft_status": "",
"field_group": "1",
"search_excerpt": null,
"deft_category": "",
"deft_comments": "y",
"channel_require_membership": "y",
"channel_max_chars": null,
"channel_html_formatting": "all",
"channel_allow_img_urls": "y",
"channel_auto_link_urls": "y",
"channel_notify": "n",
"channel_notify_emails": "",
"comment_url": "",
"comment_system_enabled": "y",
"comment_require_membership": "n",
"comment_use_captcha": "n",
"comment_moderate": "n",
"comment_max_chars": "5000",
"comment_timelock": "0",
"comment_require_email": "n",
"comment_text_formatting": "xhtml",
"comment_html_formatting": "safe",
"comment_allow_img_urls": "n",
"comment_auto_link_urls": "y",
"comment_notify": "n",
"comment_notify_authors": "n",
"comment_notify_emails": "",
"comment_expiration": "0",
"search_results_url": "",
"ping_return_url": "",
"show_button_cluster": "y",
"rss_url": "",
"enable_versioning": "n",
"max_revisions": "10",
"default_entry_title": "",
"url_title_prefix": "",
"live_look_template": "0"
}
]
Create channel
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| channel_name | The short name of the new channel | required |
| channel_title | The title of the new channel | required |
| session_id | An authenticated session id | required if not using cookie |
POST /create_channel
> Content-Type: application/x-www-form-urlencoded
channel_name=new_channel&channel_title=New Channel&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"channel_id": "1"
}
Update channel
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| channel_id | The id of the channel to update | required |
| session_id | An authenticated session id | required if not using cookie |
POST /update_channel
> Content-Type: application/x-www-form-urlencoded
channel_id=1&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"channel_id": "1"
}
Delete channel
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| channel_id | The id of the channel to delete | required |
| session_id | An authenticated session id | required if not using cookie |
POST /delete_channel
> Content-Type: application/x-www-form-urlencoded
channel_id=1&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"channel_id": "1"
}
--
Channel Entries
--
Get channel entry
\* Requires authentication if specified in settings
| Request parameters | | |
| :------------- | ------------- | ------------- |
| entry_id | The id of the entry to get | required |
GET /get_channel_entry?entry_id=1
< 200
< Content-Type: application/json
[
{
"entry_id": "1",
"channel_id": "1",
"author_id": "1",
"title": "First Entry",
"url_title": "first_entry",
"entry_date": "1294706913",
"expiration_date": "0",
"status": "open",
"custom_field_name": "Text"
}
]
Get channel entries
\* Requires authentication if specified in settings
| Request parameters | | | |
| :------------- | ------------- | ------------- | ------------- |
| channel_id | The id of the channel to get the entries of | optional | |
| select | A comma separated string of fields to select | optional | defaults to all fields |
| where | An object of field value pairs to match entries against | optional | |
| order_by | The field to order the entries by | optional | defaults to "channel_id" |
| sort | The sort order of the entries | optional | defaults to "desc" |
| limit | The number of entries to get | optional | |
| offset | The number of entries to offset by | optional | |
GET /get_channel_entries?channel_id=1&select=title,url_title,entry_date&where[status]=open&where[entry_date]=1368192049&where[custom_field_name]=Text&order_by=title&sort=asc&limit=10&offset=2
< 200
< Content-Type: application/json
[
{
"entry_id": "1",
"channel_id": "1",
"author_id": "1",
"title": "First Entry",
"url_title": "first_entry",
"entry_date": "1294706913",
"expiration_date": "0",
"status": "open",
"custom_field_name": "Text"
},
{
"entry_id": "2",
"channel_id": "1",
"author_id": "1",
"title": "Second Entry",
"url_title": "second_entry",
"entry_date": "1295535329",
"expiration_date": "0",
"status": "open",
"custom_field_name": "Text"
}
]
Create channel entry
\* Requires member authentication and correct permissions
| Request parameters | | | |
| :------------- | ------------- | ------------- | ------------- |
| channel_id | The id of the channel to create the entry in | required | |
| url_title | The url title of the new entry | required | |
| title | The title of the new entry | required | |
| entry_date | The entry date of the new entry | optional | defaults to current time |
| edit_date | The edit date of the new entry | optional | defaults to current time |
| custom_field_name | Any custom field name | optional | required custom fields must be submitted |
| session_id | An authenticated session id | required if not using cookie |
POST /create_channel_entry
> Content-Type: application/x-www-form-urlencoded
channel_id=1&url_title=new_entry&title=New Entry&entry_date=12345678&custom_field_name=Text&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"entry_id": "1"
}
Update channel entry
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| channel_id | The id of the channel that the entry is in | required | |
| entry_id | The id of the entry to update | required |
| url_title | The new url title of the entry | optional |
| title | The new title of the entry | optional |
| entry_date | The new entry date of the entry | optional |
| custom_field_name | Any custom field name | optional |
| session_id | An authenticated session id | required if not using cookie |
POST /update_channel_entry
> Content-Type: application/x-www-form-urlencoded
channel_id=1&entry_id=1&url_title=new_entry&title=New Entry&entry_date=12345678&custom_field_name=Text&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"entry_id": "1"
}
Delete channel entry
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| entry_id | The id of the entry or an array of entry ids to delete | required |
| session_id | An authenticated session id | required if not using cookie |
POST /delete_channel_entry
> Content-Type: application/x-www-form-urlencoded
entry_id=1&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"entry_id": "1"
}
--
Categories
--
Get category
\* Requires authentication if specified in settings
| Request parameters | | |
| :------------- | ------------- | ------------- |
| cat_id | The id of the category to get | required |
GET /get_category?cat_id=1
< 200
< Content-Type: application/json
[
{
"cat_id": "1",
"site_id": "1",
"group_id": "2",
"parent_id": "0",
"cat_name": "My Category",
"cat_url_title": "my_category",
"cat_description": "",
"cat_image": "",
"cat_order": "1"
}
]
Get categories
\* Requires authentication if specified in settings
| Request parameters | | | |
| :------------- | ------------- | ------------- | ------------- |
| select | A comma separated string of fields to select | optional | defaults to all fields |
| where | An object of field value pairs to match entries against | optional | |
| order_by | The field to order the entries by | optional | defaults to "cat_order" |
| sort | The sort order of the entries | optional | defaults to "asc" |
| limit | The number of entries to get | optional | |
| offset | The number of entries to offset by | optional | |
GET /get_categories?where[group_id]=1&order_by=cat_orer&sort=asc&limit=10&offset=2
< 200
< Content-Type: application/json
[
{
"cat_id": "1",
"site_id": "1",
"group_id": "1",
"parent_id": "0",
"cat_name": "First Category",
"cat_url_title": "first_category",
"cat_description": "",
"cat_image": "",
"cat_order": "1"
},
{
"cat_id": "2",
"site_id": "1",
"group_id": "1",
"parent_id": "0",
"cat_name": "Second Category",
"cat_url_title": "second_category",
"cat_description": "",
"cat_image": "",
"cat_order": "2"
}
]
Get categories by group
\* Requires authentication if specified in settings
| Request parameters | | |
| :------------- | ------------- | ------------- |
| group_id | The id of the category group to get the categories of | required |
GET /get_categories_by_group?group_id=2
< 200
< Content-Type: application/json
[
{
"cat_id": "1",
"site_id": "1",
"group_id": "2",
"parent_id": "0",
"cat_name": "My Category",
"cat_url_title": "my_category",
"cat_description": "",
"cat_image": "",
"cat_order": "1"
},
{
"cat_id": "2",
"site_id": "1",
"group_id": "1",
"parent_id": "0",
"cat_name": "Second Category",
"cat_url_title": "second_category",
"cat_description": "",
"cat_image": "",
"cat_order": "2"
}
]
Get categories by channel
\* Requires authentication if specified in settings
| Request parameters | | | |
| :------------- | ------------- | ------------- | ------------- |
| channel_id | The id of the channel to get the categories of | required | |
| select | A comma separated string of fields to select | optional | defaults to all fields |
| where | An object of field value pairs to match entries against | optional | |
| order_by | The field to order the entries by | optional | defaults to "cat_order" |
| sort | The sort order of the entries | optional | defaults to "asc" |
| limit | The number of entries to get | optional | |
| offset | The number of entries to offset by | optional | |
GET /get_categories_by_channel?channel_id=1
< 200
< Content-Type: application/json
[
{
"cat_id": "1",
"site_id": "1",
"group_id": "2",
"parent_id": "0",
"cat_name": "My Category",
"cat_url_title": "my_category",
"cat_description": "",
"cat_image": "",
"cat_order": "1"
},
{
"cat_id": "2",
"site_id": "1",
"group_id": "1",
"parent_id": "0",
"cat_name": "Second Category",
"cat_url_title": "second_category",
"cat_description": "",
"cat_image": "",
"cat_order": "2"
}
]
Create category
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| group_id | The id of the category group to create the category in | required |
| cat_url_title | The url title of the new category | required |
| cat_name | The name of the new category | required |
| site_id | The id of the site to create the category in | optional |
| parent_id | The id of the parent category | optional |
| cat_description | The description of the new category | optional |
| cat_order | The order of the new category | optional |
| session_id | An authenticated session id | required if not using cookie |
POST /create_category
> Content-Type: application/x-www-form-urlencoded
group_id=1&cat_url_title=new_category&cat_name=New Category&site_id=1&parent_id=0"&cat_description=New Category Description&cat_order=4&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"cat_id": "1"
}
Update category
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| cat_id | The id of the category to update | required |
| group_id | The id of the category group | optional |
| cat_url_title | The url title of the category | optional |
| cat_name | The name of the category | optional |
| parent_id | The id of the parent category | optional |
| cat_description | The description of the category | optional |
| cat_order | The order of the category | optional |
| session_id | An authenticated session id | required if not using cookie |
POST /update_category
> Content-Type: application/x-www-form-urlencoded
cat_id=1&group_id=1&cat_url_title=new_category&cat_name=New Category&site_id=1&parent_id=0"&cat_description=New Category Description&cat_order=4&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"cat_id": "1"
}
Delete category
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| cat_id | The id of the category to delete | required |
| session_id | An authenticated session id | required if not using cookie |
POST /delete_category
> Content-Type: application/x-www-form-urlencoded
cat_id=1&session_id=87b1bc8c82c40214d8682c9cbada3e91f2df6b98
< 200
< Content-Type: application/json
{
"cat_id": "1"
}
--
Category Groups
--
Get category group
\* Requires authentication if specified in settings
| Request parameters | | |
| :------------- | ------------- | ------------- |
| group_id | The id of the category group to get | required |
GET /get_category_group?group_id=1
< 200
< Content-Type: application/json
[
{
"group_id": "1",
"site_id": "1",
"group_name": "First Group",
"sort_order": "a",
"field_html_formatting": "all",
"can_edit_categories": "",
"can_delete_categories": "",
"exclude_group": "0"
}
]
Get category groups
\* Requires authentication if specified in settings
GET /get_category_groups
< 200
< Content-Type: application/json
[
{
"group_id": "1",
"site_id": "1",
"group_name": "First Group",
"sort_order": "a",
"field_html_formatting": "all",
"can_edit_categories": "",
"can_delete_categories": "",
"exclude_group": "0"
},
{
"group_id": "2",
"site_id": "1",
"group_name": "Second Group",
"sort_order": "a",
"field_html_formatting": "all",
"can_edit_categories": "",
"can_delete_categories": "",
"exclude_group": "0"
}
]
Create category group
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
POST /create_category_group
> Content-Type: application/x-www-form-urlencoded
< 200
< Content-Type: application/json
{
"group_id": "1"
}
Update category group
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| group_id | The id of the category group to update | required |
POST /update_category_group
> Content-Type: application/x-www-form-urlencoded
group_id=1
< 200
< Content-Type: application/json
{
"group_id": "1"
}
Delete category group
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| group_id | The id of the category group to delete | required |
POST /delete_category_group
> Content-Type: application/x-www-form-urlencoded
group_id=1
< 200
< Content-Type: application/json
{
"group_id": "1"
}
--
Members
--
Get member
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| member_id | The id of the member to get | required |
GET /get_member?member_id=1
< 200
< Content-Type: application/json
[
{
"member_id": "1",
"group_id": "1",
"email": "[email protected]",
"username":"test_user",
"screen_name": "Test User"
}
]
Get members
\* Requires member authentication and correct permissions
| Request parameters | | | |
| :------------- | ------------- | ------------- | ------------- |
| select | A comma separated string of fields to select | optional | defaults to all fields |
| where | An object of field value pairs to match entries against | optional | |
| order_by | The field to order the entries by | optional | defaults to "member_id" |
| sort | The sort order of the entries | optional | defaults to "asc" |
| limit | The number of entries to get | optional | |
| offset | The number of entries to offset by | optional | |
GET /get_members?where[group_id]=1&order_by=member_id&sort=asc&limit=10&offset=0
< 200
< Content-Type: application/json
[
{
"member_id": "1",
"group_id": "1",
"email": "[email protected]",
"username":"test_user",
"screen_name": "Test User"
},
{
"member_id": "2",
"group_id": "1",
"email": "[email protected]",
"username":"test_user_2",
"screen_name": "Test User 2"
}
]
--
Member Groups
--
Get member group
\* Requires member authentication and correct permissions
| Request parameters | | |
| :------------- | ------------- | ------------- |
| group_id | The id of the member group to get | required |
GET /get_member_group?group_id=1
< 200
< Content-Type: application/json
[
{
}
]
Get member groups
\* Requires member authentication and correct permissions
| Request parameters | | | |
| :------------- | ------------- | ------------- | ------------- |
| select | A comma separated string of fields to select | optional | defaults to all fields |
| where | An object of field value pairs to match entries against | optional | |
| order_by | The field to order the entries by | optional | defaults to "group_id" |
| sort | The sort order of the entries | optional | defaults to "asc" |
| limit | The number of entries to get | optional | |
| offset | The number of entries to offset by | optional | |
GET /get_member_groups?order_by=group_id&sort=asc&limit=10&offset=0
< 200
< Content-Type: application/json
[
{
}
]