From bd4bdab81ce6b6d2cd8f602677e5cbb299c0c6b0 Mon Sep 17 00:00:00 2001 From: zotlabs Date: Sun, 4 Dec 2016 02:53:17 -0800 Subject: more zot api documentation --- doc/api/api_group_members.md | 16 ++++++++++++++++ doc/api/group.md | 12 ++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 doc/api/api_group_members.md create mode 100644 doc/api/group.md (limited to 'doc/api') 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 -- cgit v1.2.3