-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
914 lines (823 loc) · 36 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
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
FORMAT: 1A
HOST: https://threadable.com/
# Threadable
Threadable is a *better mailing list* for group discussions. This API lets you control it from your application!
# Not done yet!
The Threadable API is a work-in-progress. We'll try to avoid breaking changes, of course, but you can expect
it to evolve a lot in the coming months.
If you're using this api, let us know! Drop us an email at [email protected]
# Authentication
To authenticate, you need a token. Get the token from your user profile page, https://threadable.com/profile
At the bottom of the page, there's an API token section. Hit generate, and you'll get an access token.
Then just append your token to the request. For instance, if you wanted to get the current user,
`https://threadable.com/api/users/current.json?access_token=YOUR_TOKEN_HERE`
You can also put the token in the `Access-Token:` HTTP header on your request. Use this method if you'd like to
query the API with Apiary.
**Be careful with your token**, since it confers access to your Threadable account. If you ever need to revoke
it, just hit the *Regenerate* button and you'll get a new one.
*Oauth2 coming soon!*
# Group Organizations
An Organization can contain many groups, conversations, and messages. A user can be a member of many organizations.
## Organizations Collection [/api/organizations]
### List all Organizations [GET]
+ Response 200 (application/json)
{
"organizations":[
{
"id":3,
"param":"raceteam",
"name":"UCSD Electric Racing",
"short_name":"RaceTeam",
"slug":"raceteam",
"subject_tag":"RaceTeam",
"description":"Senior engineering electric race team!",
"has_held_messages":false,
"trusted":true,
"email_address_username":"raceteam",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"UCSD Electric Racing \[email protected]\u003e",
"formatted_task_email_address":"UCSD Electric Racing Tasks \[email protected]\u003e",
"groups":[
{
"id":8,
"slug":"press",
"name":"Press",
"email_address_tag":"press",
"subject_tag":"RaceTeam+Press",
"color":"#e67e22",
"auto_join":false,
"non_member_posting":"allow_replies",
"alias_email_address":"Press Enquiries \[email protected]\u003e",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"Press Enquiries \[email protected]\u003e",
"formatted_task_email_address":"Press Enquiries Tasks \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":0,
"members_count":2,
"organization_slug":"raceteam",
"current_user_is_a_member":false
},
{
"id":7,
"slug":"graphic-design",
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"RaceTeam+Graphic Design",
"color":"#f2ad40",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"UCSD Electric Racing: Graphic Design\" \[email protected]\u003e",
"formatted_task_email_address":"\"UCSD Electric Racing: Graphic Design Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":9,
"organization_slug":"raceteam",
"current_user_is_a_member":false
}
]
}
]
}
## Organization [/api/organizations/{id}]
A single Organization object with all its details.
+ Parameters
+ id (required, number, `1`) ... Numeric `id` of the Organization to perform action with.
### Retrieve an Organization [GET]
+ Response 200 (application/json)
{
"id":3,
"param":"raceteam",
"name":"UCSD Electric Racing",
"short_name":"RaceTeam",
"slug":"raceteam",
"subject_tag":"RaceTeam",
"description":"Senior engineering electric race team!",
"has_held_messages":false,
"trusted":true,
"email_address_username":"raceteam",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"UCSD Electric Racing \[email protected]\u003e",
"formatted_task_email_address":"UCSD Electric Racing Tasks \[email protected]\u003e",
"groups":[
{
"id":8,
"slug":"press",
"name":"Press",
"email_address_tag":"press",
"subject_tag":"RaceTeam+Press",
"color":"#e67e22",
"auto_join":false,
"non_member_posting":"allow_replies",
"alias_email_address":"Press Enquiries \[email protected]\u003e",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"Press Enquiries \[email protected]\u003e",
"formatted_task_email_address":"Press Enquiries Tasks \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":0,
"members_count":2,
"organization_slug":"raceteam",
"current_user_is_a_member":false
},
{
"id":7,
"slug":"graphic-design",
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"RaceTeam+Graphic Design",
"color":"#f2ad40",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"UCSD Electric Racing: Graphic Design\" \[email protected]\u003e",
"formatted_task_email_address":"\"UCSD Electric Racing: Graphic Design Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":9,
"organization_slug":"raceteam",
"current_user_is_a_member":false
}
]
}
# Group Groups
## Groups collection [/api/groups]
### Create a Group [POST]
+ Request (application/json)
{
"group":{
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"Design",
"color":"#D35400",
"auto_join":false,
"non_member_posting":"allow_replies",
},
"organization_id":"raceteam"
}
+ Response 201 (application/json)
{
"id":7,
"slug":"graphic-design",
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"RaceTeam+Graphic Design",
"color":"#f2ad40",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"UCSD Electric Racing: Graphic Design\" \[email protected]\u003e",
"formatted_task_email_address":"\"UCSD Electric Racing: Graphic Design Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":9,
"organization_slug":"raceteam",
"current_user_is_a_member":false
}
## Group [/api/groups/{id}]
A single Group object with all its details
+ Parameters
+ id (required, number, `1`) ... Numeric `id` of the Group to perform action with.
### Retrieve a Group [GET]
+ Response 200 (application/json)
{
"id":7,
"slug":"graphic-design",
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"RaceTeam+Graphic Design",
"color":"#f2ad40",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"UCSD Electric Racing: Graphic Design\" \[email protected]\u003e",
"formatted_task_email_address":"\"UCSD Electric Racing: Graphic Design Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":9,
"organization_slug":"raceteam",
"current_user_is_a_member":false
}
### Update a Group [PUT]
+ Request (application/json)
{
"group":{
"subject_tag":"Design",
"color":"#D35400",
"auto_join":false,
"non_member_posting":"allow_replies",
"alias_email_address":"Design Team \[email protected]\u003e",
"webhool_url":"http://example.com/hookreceiver"
},
"organization_id":"raceteam"
}
+ Response 201 (application/json)
{
"id":7,
"slug":"graphic-design",
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"RaceTeam+Graphic Design",
"color":"#f2ad40",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"Design Team \[email protected]\u003e",
"webhool_url":"http://example.com/hookreceiver",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"UCSD Electric Racing: Graphic Design\" \[email protected]\u003e",
"formatted_task_email_address":"\"UCSD Electric Racing: Graphic Design Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":9,
"organization_slug":"raceteam",
"current_user_is_a_member":false
}
### Remove a Group [DELETE]
+ Response 204
## Group join action [/api/groups/{id}/join]
Add the current user to a group
+ Parameters
+ id (required, number, `1`) ... Numeric `id` of the Group to perform action with.
### Join a Group [POST]
+ Request
(empty)
+ Response 200 (application/json)
{
"id":7,
"slug":"graphic-design",
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"RaceTeam+Graphic Design",
"color":"#f2ad40",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"UCSD Electric Racing: Graphic Design\" \[email protected]\u003e",
"formatted_task_email_address":"\"UCSD Electric Racing: Graphic Design Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":9,
"organization_slug":"raceteam",
"current_user_is_a_member":false
}
## Group leave action [/api/groups/{id}/leave]
Remove the current user from a group
+ Parameters
+ id (required, number, `1`) ... Numeric `id` of the Group to perform action with.
### Leave a Group [POST]
+ Request
(empty)
+ Response 200 (application/json)
{
"id":7,
"slug":"graphic-design",
"name":"Graphic Design",
"email_address_tag":"graphic-design",
"subject_tag":"RaceTeam+Graphic Design",
"color":"#f2ad40",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"UCSD Electric Racing: Graphic Design\" \[email protected]\u003e",
"formatted_task_email_address":"\"UCSD Electric Racing: Graphic Design Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":9,
"organization_slug":"raceteam",
"current_user_is_a_member":false
}
# Group Conversations
## Conversations Collection [/api/conversations?organization={organization}&group={group}&scope={scope}&page={page}]
+ Parameters
+ organization (required, string, `sfhealth`) ... String slug of the Organization to perform action with.
+ group (required, string, `triage`) ... Group slug. Special slugs: `my` (all the user's subscribed groups), `ungrouped` (conversations with no group)
+ scope (optional, string, `not-done-tasks`) ... Which type of messages to fetch. Valid scopes: `muted_conversations`, `not_muted_conversations`, `done_tasks`, `not_done_tasks`, `done_doing_tasks`, `not_done_doing_tasks`
+ page (optional, numeric, `0`) ... The page of results to return
### List all Conversations [GET]
+ Response 200 (application/json)
{
"conversations":[
{
"id":51,
"slug":"inventory-led-supplies",
"organization_slug":"raceteam",
"subject":"inventory led supplies",
"task":true,
"created_at":"2014-02-02T19:10:58.850Z",
"updated_at":"2014-02-02T19:41:14.719Z",
"last_message_at":"2014-02-02T19:12:57.798Z",
"participant_names":[
"Alice", "Bob"
],
"number_of_messages":1,
"message_summary":"Cars need lights, so lets get a sense of our led si",
"group_ids":[
5,
7,
6
],
"doers":[
],
"doing":false,
"done_at":null,
"done":false,
"position":10,
"muted":false
},
{
"id":47,
"slug":"get-some-4-gauge-wire",
"organization_slug":"raceteam",
"subject":"get some 4 gauge wire",
"task":true,
"created_at":"2014-02-02T13:48:39.805Z",
"updated_at":"2014-02-02T13:54:32.417Z",
"last_message_at":null,
"participant_names":[
"Alice"
],
"number_of_messages":0,
"message_summary":null,
"group_ids":[
5,
6
],
"doers":[
],
"doing":false,
"done_at":null,
"done":false,
"position":9,
"muted":false
}
]
}
### Create a conversation [POST]
+ Request (application/json)
{
"conversation":{
"subject":"Fundraiser party",
"task":false,
"group_ids":[
6
],
},
"organization_id":"raceteam"
}
+ Response 201 (application/json)
{
"conversation":{
"id":52,
"slug":"fundraiser-party",
"organization_slug":"raceteam",
"subject":"Fundraiser party",
"task":false,
"created_at":"2014-04-16T23:18:32.012Z",
"updated_at":"2014-04-16T23:18:32.331Z",
"last_message_at":null,
"participant_names":[
"Darth"
],
"number_of_messages":0,
"message_summary":null,
"group_ids":[
6
],
"doers":[
],
"doing":null,
"done_at":null,
"done":null,
"position":-1,
"muted":false
}
}
### Update a Conversation [PUT]
+ Request (application/json)
{
"conversation":{
"id":32,
"task":true,
"group_ids":[
6,
8
]
},
"organization_id":"raceteam"
}
+ Response 201 (application/json)
{
"conversation":{
"id":32,
"slug":"fundraiser-party",
"organization_slug":"raceteam",
"subject":"Fundraiser party",
"task":true,
"created_at":"2014-04-16T23:18:32.012Z",
"updated_at":"2014-04-16T23:18:32.331Z",
"last_message_at":null,
"participant_names":[
"Darth"
],
"number_of_messages":0,
"message_summary":null,
"group_ids":[
6,
8
],
"doers":[],
"doing":null,
"done_at":null,
"done":null,
"position":-1,
"muted":false
}
}
## Conversations Search [/api/conversations/search?organization_id={organization_id}&q={q}&group={group}]
+ Parameters
+ organization_id (required, number, `2`) ... Numeric `id` of the Organization to perform action with.
+ q (required, string, `donuts`) ... String for which to query.
+ group (required, string, `electronics`) ... Group slug. Special slugs: `my` (all the user's subscribed groups), `ungrouped` (conversations with no group)
### List Conversations matching query [GET]
+ Response 200 (application/json)
{
"conversations":[
{
"id":52,
"slug":"fundraiser-party",
"organization_slug":"raceteam",
"subject":"Fundraiser Party",
"task":false,
"created_at":"2014-02-28T18:58:47.384Z",
"updated_at":"2014-04-22T21:23:37.927Z",
"last_message_at":"2014-04-22T21:22:10.147Z",
"participant_names":[
"Darth",
"Joe",
"Nicole"
],
"number_of_messages":5,
"message_summary":"let's do this next wednesday. i have the perfect venue for",
"group_ids":[
6,
],
"doers":[
],
"doing":null,
"done_at":null,
"done":null,
"position":-1,
"muted":false
}
]
}
# Group Events
A conversation has many events. Some events are simple, like adding or removing a group.
Other events are more complex, like composing a message. Each event record will include
associated records. So, a Composed Message event will include the message, which will
in turn include links to that message's attachments.
Event types: `conversation_created`, `conversation_added_group`, `conversation_removed_group`, `created_message`, `task_created`, `task_done`, `task_added_doer`, `task_undone`, `task_removed_doer`
## Events Collection [/api/events?organization_id={organization_id}&conversation_id={conversation_id}]
+ Parameters
+ organization_id (required, string, `sfhealth`) ... String slug of the Organization to perform action with.
+ conversation_id (required, string, `look-at-these-adorable-corgis`) ... String slug of the Conversation for which to retrieve events.
### Fetch events for a Conversation [GET]
+ Response 200 (application/json)
{
"events":[
{
"id":43,
"event_type":"conversation_created",
"actor":"Stephen Maturin",
"doer":null,
"group":null,
"created_at":"2014-04-24T15:16:46.907Z",
"message":null
},
{
"id":"message-24",
"event_type":"created_message",
"actor":"Stephen Maturin",
"doer":null,
"group":null,
"created_at":"2014-04-24T15:18:05.000Z",
"message":{
"id":24,
"unique_id":"PDUzNTkyYjJjOTA0Y2NfMTQ0MTMzZmU5YzkwNWU2ZTQyODI3N0BleGFtcGxlLmNvbT4=",
"from":"Stephen Maturin \[email protected]\u003e",
"subject":"Look at these adorable corgis!",
"body":"This is simply absurd.",
"body_stripped":"This is simply absurd.",
"message_id_header":"\[email protected]\u003e",
"references_header":null,
"date_header":"Thu, 24 Apr 2014 15:18:05 -0000",
"html":false,
"root":true,
"shareworthy":false,
"knowledge":false,
"created_at":"2014-04-24T15:18:26.478Z",
"sent_at":"2014-04-24T15:18:05.000Z",
"parent_message_id":null,
"avatar_url":"/fixture_images/stephen.jpg",
"sender_name":"Stephen Maturin",
"attachments":[
{
"url":"/storage/development/9aca244b-639d-46b4-9618-53736042bf12/some.gif",
"filename":"corgis.gif",
"mimetype":"image/gif",
"size":1829,
"content_id":"\u003csomegifcontentid\u003e"
}
]
}
},
{
"id":"message-25",
"event_type":"created_message",
"actor":"Ritsuko Akagi",
"doer":null,
"group":null,
"created_at":"2014-04-24T16:18:42.000Z",
"message":{
"id":25,
"unique_id":"PDUzNTkzOTYxM2E0M2JfMTQ0MTMzZmU5YzkwNWU2ZTQyODNlOEBleGFtcGxlLmNvbT4=",
"from":"Ritsuko Akagi \[email protected]\u003e",
"subject":"Look at these adorable corgis!",
"body":"We claim this stick in the name of England and Queen Elizabeth! And more!",
"body_stripped":"We claim this stick in the name of England and Queen Elizabeth!",
"message_id_header":"\[email protected]\u003e",
"references_header":"\[email protected]\u003e",
"date_header":"Thu, 24 Apr 2014 16:18:42 -0000",
"html":false,
"root":false,
"shareworthy":false,
"knowledge":false,
"created_at":"2014-04-24T16:18:58.928Z",
"sent_at":"2014-04-24T16:18:42.000Z",
"parent_message_id":24,
"avatar_url":"/fixture_images/ritsuko.jpg",
"sender_name":"Ritsuko Akagi",
"attachments":[]
}
}
]
}
# Group Messages
When creating a message, make sure to first create the conversation that the message lives in.
For the message body, you can specify any of `body`, `body_plain`, `body_html`, `stripped_plain`,
`stripped_html` and Threadable will figure out what to do.
Note: The stripped- forms are the same as the body, but with quoted text removed.
## Messages Collection [/api/messages]
### Create a Message [POST]
+ Request (application/json)
{
"message":{
"conversation_id":33,
"conversation_slug":"lets-make-breakfast",
"organization_slug":"sfhealth",
"subject":"Let's make breakfast",
"body_plain":"I have everything we need for pancakes. We could also make biscuits.",
"body_html":"<p>I have everything we need for pancakes. We could also make biscuits.</p>",
"html":false
},
"organization_id":"sfhealth"
}
+ Response 201 (application/json)
{
"message":{
"id":27,
"unique_id":"PDUzNjY5ODRjODYyNjRfODZjMDNmZWIwODg2NzBlNDU1NmVmQGxvY2FsaG9zdD4=",
"from":"Ian Baker \[email protected]\u003e",
"subject":"Let's make breakfast",
"body":"\u003cp\u003eI have everything we need for pancakes. We could also make biscuits.\u003c/p\u003e",
"body_stripped":"\u003cp\u003eI have everything we need for pancakes. We could also make biscuits.\u003c/p\u003e",
"message_id_header":"\[email protected]\u003e",
"references_header":null,
"date_header":"Sun, 04 May 2014 19:43:08 -0000",
"html":true,
"root":true,
"shareworthy":false,
"knowledge":false,
"created_at":"2014-05-04T19:43:08.551Z",
"sent_at":"2014-05-04T19:43:08.000Z",
"parent_message_id":null,
"avatar_url":"//gravatar.com/avatar/e792b3a504932f24c669684b64c5edc9.png?s=70\u0026d=retro",
"sender_name":"Ian Baker",
"attachments":[
],
"conversation":{
"id":33,
"slug":"lets-make-breakfast",
"organization_slug":"sfhealth",
"subject":"Let's make breakfast",
"task":false,
"created_at":"2014-05-04T19:43:08.269Z",
"updated_at":"2014-05-04T19:43:25.940Z",
"last_message_at":"2014-05-04T19:43:08.551Z",
"participant_names":[
"Ian"
],
"number_of_messages":1,
"message_summary":"I have everything we need for pancakes. We could al",
"group_ids":[
1
],
"doers":[]
"doing":null,
"done_at":null,
"done":null,
"position":-1,
"muted":false
}
}
}
# Group Current User
The current user record tells you about your own account. It also contains links to all of
the current user's groups.
## Current User [/api/users/current]
### Fetch the current user [GET]
+ Response 200 (application/json)
{
"user":{
"id":"current",
"user_id":3,
"param":"ian-baker",
"name":"Ian Baker",
"email_address":"[email protected]",
"slug":"ian-baker",
"avatar_url":"//gravatar.com/avatar/e792b3a504932f24c669684b64c5edc9.png?s=70\u0026d=retro",
"external_authorizations":[],
"current_organization_id":2,
"organizations":[
{
"id":1,
"param":"raceteam",
"name":"Electric Race Car Team",
"short_name":"raceteam",
"slug":"raceteam",
"subject_tag":"raceteam",
"description":"Senior engineering electric race car team!",
"has_held_messages":false,
"trusted":false,
"email_address_username":"raceteam",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"Other Admins \[email protected]\u003e",
"formatted_task_email_address":"Other Admins Tasks \[email protected]\u003e",
"groups":[]
},
{
"id":2,
"param":"sfhealth",
"name":"SF Health Center",
"short_name":"SFHealth",
"slug":"sfhealth",
"subject_tag":"SFHealth",
"description":"San Francisco Health Center",
"has_held_messages":false,
"trusted":false,
"email_address_username":"sfhealth",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"SF Health Center \[email protected]\u003e",
"formatted_task_email_address":"SF Health Center Tasks \[email protected]\u003e",
"groups":[
{
"id":4,
"slug":"cardiology",
"name":"Cardiology",
"email_address_tag":"cardiology",
"subject_tag":"SFHealth+Cardiology",
"color":"#d94876",
"auto_join":false,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"SF Health Center: Cardiology\" \[email protected]\u003e",
"formatted_task_email_address":"\"SF Health Center: Cardiology Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":1,
"members_count":6,
"organization_slug":"sfhealth",
"current_user_is_a_member":false
},
{
"id":3,
"slug":"anesthiology",
"name":"Anesthiology",
"email_address_tag":"anesthiology",
"subject_tag":"SFHealth+Anesthiology",
"color":"#f2ad40",
"auto_join":false,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"SF Health Center: Anesthiology\" \[email protected]\u003e",
"formatted_task_email_address":"\"SF Health Center: Anesthiology Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":2,
"members_count":6,
"organization_slug":"sfhealth",
"current_user_is_a_member":false
},
{
"id":2,
"slug":"triage",
"name":"Triage",
"email_address_tag":"triage",
"subject_tag":"SFHealth+Triage",
"color":"#5a9de1",
"auto_join":false,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"SF Health Center: Triage\" \[email protected]\u003e",
"formatted_task_email_address":"\"SF Health Center: Triage Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":11,
"members_count":11,
"organization_slug":"sfhealth",
"current_user_is_a_member":false
},
{
"id":1,
"slug":"social",
"name":"Social",
"email_address_tag":"social",
"subject_tag":"SFHealth+Social",
"color":"#3498db",
"auto_join":true,
"non_member_posting":"allow_replies",
"alias_email_address":"",
"webhook_url":"",
"email_address":"[email protected]",
"task_email_address":"[email protected]",
"formatted_email_address":"\"SF Health Center: Social\" \[email protected]\u003e",
"formatted_task_email_address":"\"SF Health Center: Social Tasks\" \[email protected]\u003e",
"internal_email_address":"[email protected]",
"internal_task_email_address":"[email protected]",
"conversations_count":8,
"members_count":17,
"organization_slug":"sfhealth",
"current_user_is_a_member":true
}
]
}
],
"dismissed_welcome_modal":true
}
}
# Group Organization Members
Coming soon!
## Organization Members Collection [/api/organization_members]
## Organization Member [/api/organization_members/{id}]
# Group Group Members
Coming soon!
## Group Members Collection [/api/group_members]
## Group Member [/api/group_members/{id}]
# Group Task Doers
Coming soon!
## Task Doers Collection [/api/task_doers]
## Task Doer [/api/task_doers/{id}]