aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/api_group_members.md16
-rw-r--r--doc/api/group.md12
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/api/api_group_members.md b/doc/api/api_group_members.md
new file mode 100644
index 000000000..f4bcfa4e3
--- /dev/null
+++ b/doc/api/api_group_members.md
@@ -0,0 +1,16 @@
+API group_members
+=================
+
+GET /api/z/1.0/group_members
+
+
+
+Required:
+
+ group_id or group_name
+
+
+Returns:
+
+ abook+xchan (DB join) for each member of the privacy group
+
diff --git a/doc/api/group.md b/doc/api/group.md
new file mode 100644
index 000000000..76df1c8e6
--- /dev/null
+++ b/doc/api/group.md
@@ -0,0 +1,12 @@
+API group
+=========
+
+GET /api/z/1.0/group
+
+
+Description: list privacy groups
+
+
+Returns: DB tables of all privacy groups. To use with API group_members, provide group_id from the id element returned in this call, or group_name from the gname returned in this call.
+
+ \ No newline at end of file