about summary refs log tree commit diff
path: root/docs/Using-the-API
diff options
context:
space:
mode:
authorEugen Rochko <eugen@zeonfederated.com>2017-03-15 22:55:58 +0100
committerEugen Rochko <eugen@zeonfederated.com>2017-03-15 22:55:58 +0100
commit7b58c1a694eed95e367cc8d078f91c390dffec4d (patch)
tree3a00b0cda91fc0bf28e78bab91d9cc93647e9f56 /docs/Using-the-API
parent74ae158c2f7b7d282ce1cc754ac83d27467a7215 (diff)
parente245115f47082ffba27205f508301d14e792c369 (diff)
Merge branch 'mastodon-site-api' of https://github.com/marrus-sh/ardipithecus into marrus-sh-mastodon-site-api
Diffstat (limited to 'docs/Using-the-API')
-rw-r--r--docs/Using-the-API/API.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/Using-the-API/API.md b/docs/Using-the-API/API.md
index af7858286..2c323d559 100644
--- a/docs/Using-the-API/API.md
+++ b/docs/Using-the-API/API.md
@@ -19,6 +19,7 @@ API overview
   - Who reblogged/favourited a status
   - Following/unfollowing accounts
   - Blocking/unblocking accounts
+  - Getting site information
   - Creating OAuth apps
 - [Entities](#entities)
   - Status
@@ -226,6 +227,13 @@ Returns the updated relationship to the user.
 
 Returns the updated relationship to the user.
 
+### Getting site information
+
+**GET /api/v1/site**
+
+Returns an object containing the `title`, character limit (`max_chars`), and an object of `links` for the site.
+Does not require authentication.
+
 # Muting and unmuting users
 
 **POST /api/v1/accounts/:id/mute**