aboutsummaryrefslogtreecommitdiffstats
path: root/lists.sr.ht/api.md
diff options
context:
space:
mode:
Diffstat (limited to 'lists.sr.ht/api.md')
-rw-r--r--lists.sr.ht/api.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/lists.sr.ht/api.md b/lists.sr.ht/api.md
index 2f819f2..e47bb71 100644
--- a/lists.sr.ht/api.md
+++ b/lists.sr.ht/api.md
@@ -83,13 +83,13 @@ available for lists.sr.ht:
**Note**: in all routes, `:username` may be substituted with an email address,
and `:email-id` may be the email's either of the "id" or "message_id" values.
-### GET /api/:username
+### GET /api/user/:username
Retrieves a user resource.
### GET /api/user
-Equivalent to [/api/:username](#GET-apiusername), implies the authenticated
+Equivalent to [/api/user/:username](#GET-apiusername), implies the authenticated
user.
### GET /api/user/:username/emails
@@ -98,9 +98,9 @@ List of [email resources](#email-resource) received from this user.
**OAuth scope**: `emails:read`
-### GET /api/user/emails
+### GET /api/emails
-Equivalent to [/api/:username/emails](#GET-apiusernameemails), implies the
+Equivalent to [/api/user/:username/emails](#GET-apiusernameemails), implies the
authenticated user.
**OAuth scope**: `emails:read`
@@ -149,7 +149,7 @@ List of [mailing list resources](#mailing-list-resource) owned by this user.
### GET /api/lists
-Equivalent to [/api/:username/lists](#GET-apiusernamelists), implies the
+Equivalent to [/api/user/:username/lists](#GET-apiusernamelists), implies the
authenticated user.
**OAuth scope**: `lists:read`
@@ -181,7 +181,7 @@ Retrieves a [mailing list resource](#mailing-list-resource).
### GET /api/lists/:list-name
-Equivalent to [/api/:username/lists/:list-name](#GET-apiusernamelistslist-name),
+Equivalent to [/api/user/:username/lists/:list-name](#GET-apiusernamelistslist-name),
implies the authenticated user.
**OAuth scope**: `lists:read`
@@ -213,7 +213,7 @@ List of [email resources](#email-resource) posted to this list.
### GET /api/lists/:list-name/posts
Equivalent to
-[/api/:username/lists/:list-name/posts](#GET-apiusernamelistslist-nameposts),
+[/api/user/:username/lists/:list-name/posts](#GET-apiusernamelistslist-nameposts),
implies the authenticated user.
**OAuth scope**: `lists:read`