--- /dev/null
+# Friendica API entities
+
+* [Home](help)
+ * [Using the APIs](help/api)
+
+
+## Activities
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>like</code></td>
+<td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>dislike</code></td>
+<td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>attendyes</code></td>
+<td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>attendno</code></td>
+<td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>attendmaybe</code></td>
+<td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
+<td align="center">No</td>
+</tr>
+
+</tbody>
+</table>
+
+## Attachment
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>mimetype</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>size</code></td>
+<td>Integer (bytes)</td>
+<td align="center">No</td>
+</tr>
+
+</tbody>
+</table>
+
+## Contact
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td><code>id</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>id_str</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>name</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>screen_name</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>location</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>description</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>profile_image_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>profile_image_url_https</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>profile_image_url_profile_size</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>profile_image_url_large</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>protected</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>followers_count</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>friends_count</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>listed_count</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>favourites_count</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>statuses_count</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>created_at</code></td>
+<td>String (Date)<br/>
+Ex: Wed May 23 06:01:13 +0000 2007
+</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>utc_offset</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>time_zone</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>geo_enabled</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>verified</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>lang</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>contributors_enabled</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>is_translator</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>is_translation_enabled</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>following</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>follow_request_sent</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>statusnet_blocking</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>notifications</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>statusnet_profile_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>uid</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>cid</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>pid</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>self</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>network</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+</tbody>
+</table>
+
+
+## Entities
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>hashtags</code></td>
+<td>List of <a href="help/API-Entities#Hashtag">Hashtags</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>symbols</code></td>
+<td>List of <a href="help/API-Entities#Symbol">Symbols</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>urls</code></td>
+<td>List of <a href="help/API-Entities#URL">URLs</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>user_mentions</code></td>
+<td>List of <a href="help/API-Entities#User+Mention">User mentions</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>media</code></td>
+<td>List of <a href="help/API-Entities#Media">Medias</a></td>
+<td align="center">No</td>
+</tr>
+
+</tbody>
+</table>
+
+## Hashtag
+
+Unused
+
+## Item
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td><code>text</code></td>
+<td>String (Plaintext)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>truncated</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>created_at</code></td>
+<td>String (Date)<br/>
+Ex: Wed May 23 06:01:13 +0000 2007
+</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>in_reply_to_status_id</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>in_reply_to_status_id_str</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>source</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>id</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>id_str</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>in_reply_to_user_id</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>in_reply_to_user_id_str</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>in_reply_to_screen_name</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>geo</code></td>
+<td>String</td>
+<td align="center">Yes</td>
+</tr>
+
+<tr>
+<td><code>favorited</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>user</code></td>
+<td><a href="help/API-Entities#Contact">Contact</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>friendica_author</code></td>
+<td><a href="help/API-Entities#Contact">Contact</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>friendica_owner</code></td>
+<td>
+
+<a href="help/API-Entities#Contact">Contact</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>friendica_private</code></td>
+<td>Boolean</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>statusnet_html</code></td>
+<td>String (HTML)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>statusnet_conversation_id</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>external_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>friendica_activities</code></td>
+<td><a href="help/API-Entities#Activities">Activities</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>friendica_title</code></td>
+<td>String (Plaintext)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>friendica_html</code></td>
+<td>String (HTML)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>attachments</code></td>
+<td>List of <a href="help/API-Entities#Attachment">Attachments</a></td>
+<td align="center">Yes</td>
+</tr>
+
+<tr>
+<td><code>entities</code></td>
+<td><a href="help/API-Entities#Entities">Entities</a></td>
+<td align="center">Yes</td>
+</tr>
+
+</tbody>
+</table>
+
+## Media
+
+Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/entities-object#media).
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>id</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>id_str</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>indices</code></td>
+<td>List of Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>media_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>media_url_https</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>display_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>expanded_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>ext_alt_text</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>type</code></td>
+<td>String</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>sizes</code></td>
+<td><a href="help/API-Entities#Sizes">Sizes</a></td>
+<td align="center">No</td>
+</tr>
+
+</tbody>
+</table>
+
+## Notification
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>id</code></td>
+<td>Integer</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>hash</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>type</code></td>
+<td>Integer</td>
+<td><ul>
+<li>1: Inbound follow request</li>
+<li>2: Outbound follow request confirmation</li>
+<li>4: Wall-to-wall post</li>
+<li>8: Reply</li>
+<li>16: Private message</li>
+<li>32: Friend suggestion</li>
+<li>64: Unused</li>
+<li>128: Mention</li>
+<li>256: Tag added to a post</li>
+<li>512: Poke</li>
+<li>1024: New post</li>
+<li>16384: System email</li>
+<li>32768: System event</li>
+</ul></td>
+</tr>
+
+<tr>
+<td><code>name</code></td>
+<td>String</td>
+<td>Full name of the contact subject</td>
+</tr>
+
+<tr>
+<td><code>url</code></td>
+<td>String (URL)</td>
+<td>Profile page URL of the contact subject</td>
+</tr>
+
+<tr>
+<td><code>photo</code></td>
+<td>String (URL)</td>
+<td>Profile photo URL of the contact subject</td>
+</tr>
+
+<tr>
+<td><code>date</code></td>
+<td>String (Date)</td>
+<td><code>YYYY-MM-DD hh:mm:ss</code> local server time</td>
+</tr>
+
+<tr>
+<td><code>msg</code></td>
+<td>String (BBCode)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>uid</code></td>
+<td>Integer</td>
+<td>Owner User Id</td>
+</tr>
+
+<tr>
+<td><code>link</code></td>
+<td>String (URL)</td>
+<td>Notification URL</td>
+</tr>
+
+<tr>
+<td><code>iid</code></td>
+<td>Integer</td>
+<td>Item Id</td>
+</tr>
+
+<tr>
+<td><code>parent</code></td>
+<td>Integer</td>
+<td>Parent Item Id</td>
+</tr>
+
+<tr>
+<td><code>seen</code></td>
+<td>Integer (Boolean)</td>
+<td>Whether the notification was read or not.</td>
+</tr>
+
+<tr>
+<td><code>verb</code></td>
+<td>String (URL)</td>
+<td>[Activity Streams](http://activitystrea.ms) Verb URL</td>
+</tr>
+
+<tr>
+<td><code>seen</code></td>
+<td>Integer (Boolean)</td>
+<td>Whether the notification was read or not.</td>
+</tr>
+
+<tr>
+<td><code>otype</code></td>
+<td>Enum</td>
+<td>Subject type (`item`, `intro` or `mail`)</td>
+</tr>
+
+<tr>
+<td><code>name_cache</code></td>
+<td>String (HTML)</td>
+<td>Full name of the contact subject</td>
+</tr>
+
+<tr>
+<td><code>msg_cache</code></td>
+<td>String (Plaintext)</td>
+<td>Plaintext version of the notification text with a placeholder (`{0}`) for the subject contact's name.</td>
+</tr>
+
+<tr>
+<td><code>timestamp</code></td>
+<td>Integer</td>
+<td>Unix timestamp</td>
+</tr>
+
+<tr>
+<td><code>date_rel</code></td>
+<td>String</td>
+<td>Time since the note was posted, eg "1 hour ago"</td>
+</tr>
+
+
+<tr>
+<td><code>msg_html</code></td>
+<td>String (HTML)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>msg_plain</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+</tbody>
+</table>
+
+## Photo
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>id</code></td>
+<td>String</td>
+<td>Resource ID (32 hex chars)</td>
+</tr>
+
+<tr>
+<td><code>created</code></td>
+<td>String (Date)</td>
+<td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
+</tr>
+
+<tr>
+<td><code>edited</code></td>
+<td>String (Date)</td>
+<td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
+</tr>
+
+<tr>
+<td><code>title</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>desc</code></td>
+<td>String (Plaintext)</td>
+<td>Picture caption</td>
+</tr>
+
+<tr>
+<td><code>album</code></td>
+<td>String</td>
+<td>Album name</td>
+</tr>
+
+<tr>
+<td><code>filename</code></td>
+<td>String</td>
+<td>Original image filename</td>
+</tr>
+
+<tr>
+<td><code>type</code></td>
+<td>String</td>
+<td>MIME Type</td>
+</tr>
+
+<tr>
+<td><code>height</code></td>
+<td>Integer</td>
+<td>Image height in pixels</td>
+</tr>
+
+<tr>
+<td><code>width</code></td>
+<td>Integer</td>
+<td>Image width in pixels</td>
+</tr>
+
+<tr>
+<td><code>profile</code></td>
+<td>Integer</td>
+<td>1 if it is a profile photo</td>
+</tr>
+
+<tr>
+<td><code>allow_cid</code></td>
+<td>String (ACL)</td>
+<td>List of contact ids wrapped in angle brackets allowed to access the photo.</td>
+</tr>
+
+<tr>
+<td><code>allow_gid</code></td>
+<td>String (ACL)</td>
+<td>List of contact group ids wrapped in angle brackets allowed to access the photo.</td>
+</tr>
+
+<tr>
+<td><code>deny_cid</code></td>
+<td>String (ACL)</td>
+<td>List of contact ids wrapped in angle brackets forbidden to access the photo.</td>
+</tr>
+
+<tr>
+<td><code>deny_gid</code></td>
+<td>String (ACL)</td>
+<td>List of contact group ids wrapped in angle brackets forbidden to access the photo.</td>
+</tr>
+
+<tr>
+<td><code>link</code></td>
+<td>Array of Strings (URL)</td>
+<td>
+URLs to the different scales indexed by scale number if no specific scale was requested.
+Mutually exclusive with <code>data</code> <code>datasize</code>.
+</td>
+</tr>
+
+<tr>
+<td><code>datasize</code></td>
+<td>Integer</td>
+<td>
+Picture size in bytes if a single scale was requested.
+Mutually exclusive with <code>link</code>.
+</td>
+</tr>
+
+<tr>
+<td><code>data</code></td>
+<td>String</td>
+<td>
+Base64-encoded image data if a single scale was requested.
+Mutually exclusive with <code>link</code>.
+</td>
+</tr>
+
+<tr>
+<td><code>friendica_activities</code></td>
+<td><a href="help/API-Entities#Activities">Activities</a></td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>friendica_comments</code></td>
+<td>List of <a href="help/API-Entities#Item">Items</a></td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>rights_mismatch</code></td>
+<td>Boolean</td>
+<td>True if the ACL differs between the picture and the associated item.</td>
+</tr>
+
+</tbody>
+</table>
+
+## Photo List Item
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>id</code></td>
+<td>String</td>
+<td>Resource ID (32 hex chars)</td>
+</tr>
+
+<tr>
+<td><code>album</code></td>
+<td>String</td>
+<td>Album name</td>
+</tr>
+
+<tr>
+<td><code>filename</code></td>
+<td>String</td>
+<td>Original image filename</td>
+</tr>
+
+<tr>
+<td><code>type</code></td>
+<td>String</td>
+<td>MIME Type</td>
+</tr>
+
+<tr>
+<td><code>created</code></td>
+<td>String (Date)</td>
+<td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
+</tr>
+
+<tr>
+<td><code>edited</code></td>
+<td>String (Date)</td>
+<td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
+</tr>
+
+<tr>
+<td><code>desc</code></td>
+<td>String (Plaintext)</td>
+<td>Picture caption</td>
+</tr>
+
+<tr>
+<td><code>thumb</code></td>
+<td>String (URL)</td>
+<td>URL of the smallest scale version of the picture.</td>
+</tr>
+
+</tbody>
+</table>
+
+## Private message
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>id</code></td>
+<td>Integer</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>sender_id</code></td>
+<td>Integer</td>
+<td>Sender Contact Id</td>
+</tr>
+
+<tr>
+<td><code>text</code></td>
+<td>String</td>
+<td>Can be HTML or plaintext depending on the API call parameter `getText`.</td>
+</tr>
+
+<tr>
+<td><code>recipient_id</code></td>
+<td>Integer</td>
+<td>Recipient Contact Id</td>
+</tr>
+
+<tr>
+<td><code>created_at</code></td>
+<td>String (Date)</td>
+<td>Ex: Wed May 23 06:01:13 +0000 2007</td>
+</tr>
+
+<tr>
+<td><code>sender_screen_name</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>recipient_screen_name</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>sender</code></td>
+<td><a href="help/API-Entities#Contact">Contact</a></td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>recipient</code></td>
+<td><a href="help/API-Entities#Contact">Contact</a></td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>title</code></td>
+<td>String</td>
+<td>Empty if the API call parameter `getText` is empty or absent.</td>
+</tr>
+
+<tr>
+<td><code>friendica_seen</code></td>
+<td>Integer (Boolean)</td>
+<td>Whether the private message has been read or not.</td>
+</tr>
+
+<tr>
+<td><code>friendica_parent_uri</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+</tbody>
+</table>
+
+## Profile
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>profile_id</code></td>
+<td>Integer</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>profile_name</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>is_default</code></td>
+<td>Boolean</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>hide_friends</code></td>
+<td>Boolean</td>
+<td>Whether the user chose to hide their contact list on their profile.</td>
+</tr>
+
+<tr>
+<td><code>profile_photo</code></td>
+<td>String (URL)</td>
+<td>Largest size profile picture URL.</td>
+</tr>
+
+<tr>
+<td><code>profile_thumb</code></td>
+<td>String (URL)</td>
+<td>Smallest size profile picture URL.</td>
+</tr>
+
+<tr>
+<td><code>publish</code></td>
+<td>Boolean</td>
+<td>Whether the user chose to publish their profile in the local directory.</td>
+</tr>
+
+<tr>
+<td><code>net_publish</code></td>
+<td>Boolean</td>
+<td>Whether the user chose to publish their profile in the global directory.</td>
+</tr>
+
+<tr>
+<td><code>description</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>date_of_birth</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>address</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>city</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>region</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>postal_code</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>country</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>hometown</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>gender</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>marital</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>marital_with</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>marital_since</code></td>
+<td>String (Date)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>sexual</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>politic</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>religion</code></td>
+<td>String</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>public_keywords</code></td>
+<td>String</td>
+<td>Comma-separated list of words meant to be displayed as hashtags.</td>
+</tr>
+
+<tr>
+<td><code>private_keywords</code></td>
+<td>String</td>
+<td>Comma-separated list of words meant to be used for search only.</td>
+</tr>
+
+<tr>
+<td><code>likes</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>dislikes</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>about</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>music</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>book</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>tv</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>film</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>interest</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>romance</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>work</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>education</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>social_networks</code></td>
+<td>String (Plaintext)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>homepage</code></td>
+<td>String (URL)</td>
+<td></td>
+</tr>
+
+<tr>
+<td><code>users</code></td>
+<td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
+<td>If populated, only these contacts have access to the profile.</td>
+</tr>
+
+</tbody>
+</table>
+
+## Size
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>w</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>h</code></td>
+<td>Integer</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>resize</code></td>
+<td>Enum (fit, crop)</td>
+<td align="center">Yes</td>
+</tr>
+
+</tbody>
+</table>
+
+
+## Sizes
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>medium</code></td>
+<td><a href="help/API-Entities#Size">Size</a></td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>large</code></td>
+<td><a href="help/API-Entities#Size">Size</a></td>
+<td align="center">Yes</td>
+</tr>
+
+<tr>
+<td><code>thumb</code></td>
+<td><a href="help/API-Entities#Size">Size</a></td>
+<td align="center">Yes</td>
+</tr>
+
+<tr>
+<td><code>small</code></td>
+<td><a href="help/API-Entities#Size">Size</a></td>
+<td align="center">Yes</td>
+</tr>
+
+</tbody>
+</table>
+
+## Symbol
+
+Unused
+
+## URL
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>expanded_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>display_url</code></td>
+<td>String (URL)</td>
+<td align="center">No</td>
+</tr>
+
+<tr>
+<td><code>indices</code></td>
+<td>List of Integer</td>
+<td align="center">No</td>
+</tr>
+
+</tbody>
+</table>
+
+## User Mention
+
+Unused
\ No newline at end of file
--- /dev/null
+# Friendica API
+
+* [Home](help)
+ * [Using the APIs](help/api)
+
+## Overview
+
+Friendica provides the following specific endpoints.
+
+Authentication is the same as described in [Using the APIs](help/api#Authentication).
+
+## Entities
+
+These endpoints uses the [Friendica API entities](help/API-Entities).
+
+## Endpoints
+
+### GET api/externalprofile/show
+
+Returns a [Contact](help/API-Entities#Contact) entity for the provided profile URL.
+
+#### Parameters
+
+- `profileurl`: Profile URL
+
+### GET api/statuses/public_timeline
+
+Returns a list of public [Items](help/API-Entities#Item) posted on this node.
+Equivalent of the local community page.
+
+#### Parameters
+
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `exclude_replies`: don't show replies (default: false)
+* `conversation_id`: Shows all statuses of a given conversation.
+* `include_entities`: "true" shows entities for pictures and links (Default: false)
+
+#### Unsupported parameters
+
+* `trim_user`
+
+### GET api/statuses/networkpublic_timeline
+
+Returns a list of public [Items](help/API-Entities#Item) this node is aware of.
+Equivalent of the global community page.
+
+#### Parameters
+
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `exclude_replies`: don't show replies (default: false)
+* `conversation_id`: Shows all statuses of a given conversation.
+* `include_entities`: "true" shows entities for pictures and links (Default: false)
+
+### GET api/statuses/replies
+
+#### Parameters
+
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `include_entities`: "true" shows entities for pictures and links (Default: false)
+
+#### Unsupported parameters
+
+* `include_rts`
+* `trim_user`
+* `contributor_details`
+
+---
+
+### GET api/conversation/show
+
+Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
+
+#### Parameters
+
+* `id`: id of the post
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `include_entities`: "true" shows entities for pictures and links (Default: false)
+
+#### Unsupported parameters
+
+* `include_rts`
+* `trim_user`
+* `contributor_details`
+
+### GET api/statusnet/conversation
+
+Alias of [`api/conversation/show`](#GET+api%2Fconversation%2Fshow).
+
+### GET api/statusnet/config
+
+Returns the public Friendica node configuration.
+
+### GET api/gnusocial/config
+
+Alias of [`api/statusnet/config`](#GET+api%2Fstatusnet%2Fconfig).
+
+### GET api/statusnet/version
+
+Returns a fake static StatusNet protocol version.
+
+### GET api/gnusocial/version
+
+Alias of [`api/statusnet/version`](#GET+api%2Fstatusnet%2Fversion).
+
+---
+
+### POST api/friendica/activity/[verb]
+
+Add or remove an activity from an item.
+'verb' can be one of:
+
+* `like`
+* `dislike`
+* `attendyes`
+* `attendno`
+* `attendmaybe`
+
+To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
+Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
+Attend verbs should be used only with event-related items (there is no check at the moment).
+
+#### Parameters
+
+* `id`: item id
+
+#### Return values
+
+On success:
+json:
+
+```"ok"```
+
+xml:
+
+```<ok>true</ok>```
+
+On error:
+HTTP 400 BadRequest
+
+---
+
+### GET api/direct_messages
+
+Deprecated Twitter received direct message list endpoint.
+
+#### Parameters
+
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `getText`: Defines the format of the status field. Can be "html" or "plain"
+* `include_entities`: "true" shows entities for pictures and links (Default: false)
+* `friendica_verbose`: "true" enables different error returns (default: "false")
+
+#### Unsupported parameters
+
+* `skip_status`
+
+### GET api/direct_messages/all
+
+Returns all [Private Messages](help/API-Entities#Private+message).
+
+#### Parameters
+
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `getText`: Defines the format of the status field. Can be "html" or "plain"
+* `friendica_verbose`: "true" enables different error returns (default: "false")
+
+### GET api/direct_messages/conversation
+
+Returns all replies of a single private message conversation. Returns [Private Messages](help/API-Entities#Private+message)
+
+#### Parameters
+
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `getText`: Defines the format of the status field. Can be "html" or "plain"
+* `uri`: URI of the conversation
+* `friendica_verbose`: "true" enables different error returns (default: "false")
+
+### GET api/direct_messages/sent
+
+Deprecated Twitter sent direct message list endpoint. Returns [Private Messages](help/API-Entities#Private+message).
+
+#### Parameters
+
+* `count`: Items per page (default: 20)
+* `page`: page number
+* `since_id`: minimum id
+* `max_id`: maximum id
+* `getText`: Defines the format of the status field. Can be "html" or "plain"
+* `include_entities`: "true" shows entities for pictures and links (Default: false)
+* `friendica_verbose`: "true" enables different error returns (default: "false")
+
+
+### POST/PUT api/direct_messages/new
+
+Deprecated Twitter direct message submission endpoint.
+
+#### Parameters
+
+* `user_id`: id of the user
+* `screen_name`: screen name (for technical reasons, this value is not unique!)
+* `text`: The message
+* `replyto`: ID of the replied direct message
+* `title`: Title of the direct message
+
+### POST/DELETE api/direct_messages/destroy
+
+Deprecated Twitter direct message deletion endpoint.
+
+#### Parameters
+
+* `id`: id of the message to be deleted
+* `include_entities`: optional, currently not yet implemented
+* `friendica_parenturi`: optional, can be used for increased safety to delete only intended messages
+* `friendica_verbose`: "true" enables different error returns (default: "false")
+
+#### Return values
+
+On success:
+
+* JSON return as defined for Twitter API not yet implemented
+* on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
+
+On error:
+HTTP 400 BadRequest
+
+* on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
+
+### GET api/friendica/direct_messages_setseen
+
+#### Parameters
+
+* `id`: id of the message to be updated as seen
+
+#### Return values
+
+On success:
+
+* JSON return `{"result": "ok", "message": "message set to seen"}`
+
+On error:
+
+* different JSON returns `{"result": "error", "message": "xyz"}`
+
+
+### GET api/friendica/direct_messages_search (GET; AUTH)
+
+Returns [Private Messages](help/API-Entities#Private+message) matching the provided search string.
+
+#### Parameters
+
+* `searchstring`: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
+* `getText` (optional): `plain`|`html` If ommited, the title is prepended to the plaintext body in the `text` attribute of the private message objects.
+* `getUserObjects` (optional): `true`|`false` If `false`, the `sender` and `recipient` attributes of the private message object are absent.
+
+#### Return values
+
+Returns only tested with JSON, XML might work as well.
+
+On success:
+
+* JSON return `{"success":"true", "search_results": array of found messages}`
+* JSOn return `{"success":"false", "search_results": "nothing found"}`
+
+On error:
+
+* different JSON returns `{"result": "error", "message": "searchstring not specified"}`
+
+---
+
+### GET api/friendica/group_show
+
+Return all or a specified group of the user with the containing contacts as array.
+
+#### Parameters
+
+* `gid`: optional, if not given, API returns all groups of the user
+
+#### Return values
+
+Array of:
+
+* `name`: name of the group
+* `gid`: id of the group
+* `user`: array of [Contacts](help/API-Entities#Contact)
+
+### POST/PUT api/friendica/group_create
+
+Create the group with the posted array of contacts as members.
+
+#### Parameters
+
+* `name`: name of the group to be created
+
+#### POST data
+
+JSON data as Array like the result of [GET api/friendica/group_show](#GET+api%2Ffriendica%2Fgroup_show):
+
+* `gid`
+* `name`
+* List of [Contacts](help/API-Entities#Contact)
+
+#### Return values
+
+Array of:
+
+* `success`: true if successfully created or reactivated
+* `gid`: gid of the created group
+* `name`: name of the created group
+* `status`: "missing user" | "reactivated" | "ok"
+* `wrong users`: array of users, which were not available in the contact table
+
+### POST api/friendica/group_update
+
+Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).
+
+#### Parameters
+
+* `gid`: id of the group to be changed
+* `name`: name of the group to be changed
+
+#### POST data
+
+JSON data as array like the result of [GET api/friendica/group_show](#GET+api%2Ffriendica%2Fgroup_show):
+
+* `gid`
+* `name`
+* List of [Contacts](help/API-Entities#Contact)
+
+#### Return values
+
+Array of:
+
+* `success`: true if successfully updated
+* `gid`: gid of the changed group
+* `name`: name of the changed group
+* `status`: "missing user" | "ok"
+* `wrong users`: array of users, which were not available in the contact table
+
+### POST/DELETE api/friendica/group_delete
+
+Delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
+
+#### Parameters
+
+* `gid`: id of the group to be deleted
+* `name`: name of the group to be deleted
+
+#### Return values
+
+Array of:
+
+* `success`: true if successfully deleted
+* `gid`: gid of the deleted group
+* `name`: name of the deleted group
+* `status`: "deleted" if successfully deleted
+* `wrong users`: empty array
+
+---
+
+### GET api/friendica/notifications
+
+Return last 50 [Notifications](help/API-Entities#Notification) for the current user, ordered by date with unseen item on top.
+
+#### Parameters
+
+none
+
+### POST api/friendica/notifications/seen
+
+Set notification as seen.
+
+#### Parameters
+
+- `id`: id of the notification to set seen
+
+#### Return values
+
+If the note is linked to an item, returns an [Item](help/API-Entities#Item).
+
+Otherwise, a success status is returned:
+
+* `success` (json) | `<status>success</status>` (xml)
+
+---
+
+### GET api/friendica/photo
+
+Returns a [Photo](help/API-Entities#Photo).
+
+#### Parameters
+
+* `photo_id`: Resource id of a photo.
+* `scale`: (optional) scale value of the photo
+
+Returns data of a picture with the given resource.
+If 'scale' isn't provided, returned data include full url to each scale of the photo.
+If 'scale' is set, returned data include image data base64 encoded.
+
+possibile scale value are:
+
+* 0: original or max size by server settings
+* 1: image with or height at <= 640
+* 2: image with or height at <= 320
+* 3: thumbnail 160x160
+* 4: Profile image at 300x300
+* 5: Profile image at 80x80
+* 6: Profile image at 48x48
+
+An image used as profile image has only scale 4-6, other images only 0-3
+
+#### Return values
+
+json:
+
+```json
+ {
+ "id": "photo id"
+ "created": "date(YYYY-MM-DD HH:MM:SS)",
+ "edited": "date(YYYY-MM-DD HH:MM:SS)",
+ "title": "photo title",
+ "desc": "photo description",
+ "album": "album name",
+ "filename": "original file name",
+ "type": "mime type",
+ "height": "number",
+ "width": "number",
+ "profile": "1 if is profile photo",
+ "link": {
+ "<scale>": "url to image"
+ ...
+ },
+ // if 'scale' is set
+ "datasize": "size in byte",
+ "data": "base64 encoded image data"
+ }
+```
+
+xml:
+
+```xml
+ <photo>
+ <id>photo id</id>
+ <created>date(YYYY-MM-DD HH:MM:SS)</created>
+ <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
+ <title>photo title</title>
+ <desc>photo description</desc>
+ <album>album name</album>
+ <filename>original file name</filename>
+ <type>mime type</type>
+ <height>number</height>
+ <width>number</width>
+ <profile>1 if is profile photo</profile>
+ <links type="array">
+ <link type="mime type" scale="scale number" href="image url"/>
+ ...
+ </links>
+ </photo>
+```
+
+### GET api/friendica/photos/list
+
+Returns the API user's [Photo List Items](help/API-Entities#Photo+List+Item).
+
+#### Return values
+
+json:
+
+```json
+ [
+ {
+ id: "resource_id",
+ album: "album name",
+ filename: "original file name",
+ type: "image mime type",
+ thumb: "url to thumb sized image"
+ },
+ ...
+ ]
+```
+
+xml:
+
+```xml
+ <photos type="array">
+ <photo id="resource_id"
+ album="album name"
+ filename="original file name"
+ type="image mime type">
+ "url to thumb sized image"
+ </photo>
+ ...
+ </photos>
+```
+
+### POST api/friendica/photo/create
+
+Alias of [`api/friendica/photo/update`](#POST+api%2Ffriendica%2Fphoto%2Fupdate)
+
+### POST api/friendica/photo/update
+
+Saves data for the scales 0-2 to database (see above for scale description).
+Call adds non-public entries to items table to enable authenticated contacts to comment/like the photo.
+Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group.
+Currently it is best to inform user that updating rights is not the right way to do this, and offer a solution to add photo as a new photo with the new rights instead.
+
+#### Parameters
+
+* `photo_id` (optional): if specified the photo with this id will be updated
+* `media` (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
+* `desc` (optional): description for the photo, updated when photo_id is specified
+* `album`: name of the album to be deleted (always necessary)
+* `album_new` (optional): can be used to change the album of a single photo if photo_id is specified
+* `allow_cid`/`allow_gid`/`deny_cid`/`deny_gid` (optional):
+ - on create: empty string or omitting = public photo, specify in format ```<x><y><z>``` for private photo
+ - on update: keys need to be present with empty values for changing a private photo to public
+
+#### Return values
+
+On success:
+
+* new photo uploaded: JSON return with photo data (see [GET api/friendica/photo](#GET+api%2Ffriendica%2Fphoto))
+* photo updated - changed photo data: JSON return with photo data (see [GET api/friendica/photo](#GET+api%2Ffriendica%2Fphoto))
+* photo updated - changed info: JSON return `{"result": "updated", "message":"Image id 'xyz' has been updated."}`
+* photo updated - nothing changed: JSON return `{"result": "cancelled","message": "Nothing to update for image id 'xyz'."}`
+
+On error:
+
+* 403 FORBIDDEN: if not authenticated
+* 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
+* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
+ "image size exceeds Friendica Config setting (uploaded size: x)",
+ "unable to process image data",
+ "image upload failed",
+ "unknown error - uploading photo failed, see Friendica log for more information",
+ "unknown error - update photo entry in database failed",
+ "unknown error - this error on uploading or updating a photo should never happen"
+
+### DELETE api/friendica/photo/delete
+
+Deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
+Sets item table entries for this photo to deleted = 1.
+
+#### Parameters
+
+* `photo_id`: id of the photo to be deleted
+
+#### Return values
+
+On success:
+
+* JSON return
+
+```json
+{
+ "result": "deleted",
+ "message": "photo with id 'xyz' has been deleted from server."
+}
+```
+
+On error:
+
+* 403 FORBIDDEN: if not authenticated
+* 400 BADREQUEST: "no photo_id specified", "photo not available"
+* 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
+
+---
+
+### POST/DELETE api/friendica/photoalbum/delete
+
+Deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this.
+
+#### Parameters
+
+* `album`: name of the album to be deleted
+
+#### Return values
+
+On success:
+
+* JSON return
+
+```json
+{
+ "result": "deleted",
+ "message": "album 'xyz' with all containing photos has been deleted."
+}
+```
+
+On error:
+
+* 403 FORBIDDEN: if not authenticated
+* 400 BADREQUEST: "no albumname specified", "album not available"
+* 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
+
+### POST/PUT api/friendica/photoalbum/update
+
+Changes the album name to album_new for all photos in album.
+
+#### Parameters
+
+* `album`: name of the album to be updated
+* `album_new`: new name of the album
+
+#### Return values
+
+On success:
+
+* JSON return
+
+```json
+{
+ "result": "updated",
+ "message":"album 'abc' with all containing photos has been renamed to 'xyz'."
+}
+```
+
+On error:
+
+* 403 FORBIDDEN: if not authenticated
+* 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
+* 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
+
+---
+
+### GET api/friendica/profile/show
+
+Returns the [Profile](help/API-Entities#Profile) data of all profiles or a single profile of the authenticated user.
+
+#### Parameters
+
+* `profile_id` (optional): id of the profile to be returned. If omitted all profiles are returned by default.
+
+#### Return values
+
+On success: Array of:
+
+* `multi_profiles`: true if user has activated multi_profiles
+* `global_dir`: URL of the global directory set in server settings
+* `friendica_owner`: user data of the authenticated user
+* `profiles`: array of the profile data
+
+On error:
+HTTP 403 Forbidden: when no authentication was provided
+HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
+
+General description of profile data in API returns:
+
+---
+
+### GET api/friendica/remoteauth
+
+Similar as /redir, redirects to `url` after DFRN authentication.
+
+#### Parameters
+
+- `c_url`: url of remote contact to auth to
+- `url`: string, url to redirect after auth
+
+## Deprecated endpoints
+
+- POST api/statuses/mediap
--- /dev/null
+# GNU Social API
+
+* [Home](help)
+ * [Using the APIs](help/api)
+
+## Overview
+
+Friendica provides the following endpoints defined in [the official GNU Social Twitter-like API reference](https://gnusocial.net/doc/twitterapi).
+
+Authentication is the same as described in [Using the APIs](help/api#Authentication).
+
+## Entities
+
+These endpoints use the [Friendica API entities](help/API-Entities).
+
+## Implemented endpoints
+
+- GET api/account/rate_limit_status
+- POST api/account/update_profile_image
+- GET api/account/verify_credentials
+
+- GET api/direct_messages
+- POST/DELETE api/direct_messages/destroy
+- POST api/direct_messages/new
+- GET api/direct_messages/sent
+- GET api/favorites
+- POST api/favorites/create/:id
+- POST api/favorites/destroy/:id
+- GET api/followers/ids
+- POST api/friendships/destroy
+- GET api/friends/ids
+- GET/POST api/help/test
+- POST api/oauth/access_token
+- POST api/oauth/request_token
+- GET api/search
+- GET api/statuses/show/:id
+- POST api/statuses/destroy/:id
+- GET api/statuses/followers
+- GET api/statuses/friends
+- GET api/statuses/friends_timeline
+- GET api/statuses/friends_timeline/:username
+- GET api/statuses/home_timeline
+- GET api/statuses/mentions
+- GET api/statuses/replies
+- GET api/statuses/replies/:username
+- POST api/statuses/retweet/:id
+- GET api/statuses/public_timeline
+- POST api/statuses/update
+- GET api/statuses/user_timeline
+- GET api/users/show
+
+## Non-implemented endpoints
+
+- statuses/retweeted_to_me
+- statuses/retweeted_by_me
+- statuses/retweets_of_me
+- friendships/create
+- friendships/exists
+- friendships/show
+- account/end_session
+- account/update_delivery_device
+- account/update_profile_background_image
+- notifications/follow
+- notifications/leave
+- blocks/create
+- blocks/destroy
+- blocks/exists
+- blocks/blocking
+- oauth/authorize
+- statusnet/groups/timeline
+- statusnet/groups/show
+- statusnet/groups/create
+- statusnet/groups/join
+- statusnet/groups/leave
+- statusnet/groups/list
+- statusnet/groups/list_all
+- statusnet/groups/membership
+- statusnet/groups/is_member
+- statusnet/tags/timeline
+- statusnet/media/upload
+- statusnet/config
--- /dev/null
+# Mastodon API
+
+* [Home](help)
+ * [Using the APIs](help/api)
+
+## Overview
+
+Friendica provides the following endpoints defined in [the official Mastodon API reference](https://docs.joinmastodon.org/api/).
+
+Authentication is the same as described in [Using the APIs](help/api#Authentication).
+
+## Entities
+
+These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/api/entities/).
+
+## Implemented endpoints
+
+- [GET /api/v1/follow_requests](https://docs.joinmastodon.org/api/rest/follow-requests/#get-api-v1-follow-requests)
+
+## Non-implemented endpoints
+
+- [POST /api/v1/follow_requests/:id/authorize](https://docs.joinmastodon.org/api/rest/follow-requests/#post-api-v1-follow-requests-id-authorize)
+- [POST /api/v1/follow_requests/:id/reject](https://docs.joinmastodon.org/api/rest/follow-requests/#post-api-v1-follow-requests-id-reject)
+
--- /dev/null
+# Twitter API
+
+* [Home](help)
+ * [Using the APIs](help/api)
+
+## Overview
+
+Friendica provides the following endpoints defined in the [official Twitter API reference](https://developer.twitter.com/en/docs/api-reference-index).
+
+Authentication is the same as described in [Using the APIs](help/api#Authentication).
+
+## Entities
+
+These endpoints use the [Friendica API entities](help/API-Entities).
+
+## Different behaviour
+
+* `screen_name`: The nick name in Friendica is only unique in each network but not for all networks. The users are searched in the following priority: Friendica, StatusNet/GNU Social, Diaspora, pump.io, Twitter. If no contact was found by this way, then the first contact is taken.
+* `include_entities`: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.
+
+## Friendica-specific return values
+
+* `cid`: Contact id of the user (important for "contact_allow" and "contact_deny")
+* `network`: network of the user
+
+## Unsupported parameters
+
+* `cursor`
+* `trim_user`
+* `contributor_details`
+* `place_id`
+* `display_coordinates`
+* `include_rts`: To-Do
+* `include_my_retweet`: Retweets in Friendica are implemented in a different way
+
+## Implemented endpoints
+
+- [POST api/oauth/access_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/access_token)
+ - Unsupported parameters:
+ - `x_auth_password`
+ - `x_auth_username`
+ - `x_auth_mode`
+- [POST api/oauth/request_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/request_token)
+ - Unsupported parameter:
+ - `x_auth_access_type`
+
+
+- [GET api/account/verify_credentials](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials)
+ - Unsupported parameter:
+ - `include_email`
+- [POST api/account/update_profile](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile)
+ - Unsupported parameters:
+ - `url`
+ - `location`
+ - `profile_link_color`
+ - `include_entities`
+ - `skip_status`
+- [POST api/account/update_profile_image](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image)
+ - Additional parameter:
+ - `profile_id` (optional): Numerical id of the profile for which the image should be used, default is changing the default profile.
+
+
+- [POST api/statuses/update](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update)
+ - Unsupported parameter:
+ - `display_coordinates`
+- [POST api/statuses/update_with_media (deprecated)](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update_with_media)
+
+
+- [POST api/media/upload](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload)
+ - Additional return value:
+ - `image.friendica_preview_url`: image preview url
+- [POST api/media/metadata/create](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-metadata-create)
+
+
+- [GET api/users/show](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show)
+- [GET api/users/search](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search)
+ - Unsupported parameters:
+ - `page`
+ - `count`
+ - `include_entities`
+- [GET api/users/lookup](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup)
+ - Unsupported parameters:
+ - `screen_name`
+ - `include_entities`
+
+
+- [GET api/search/tweets](https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets)
+ - Unsupported parameters:
+ - `geocode`
+ - `lang`
+ - `locale`
+ - `result_type`
+ - `until`
+ - `include_entities`
+
+
+- [GET api/saved_searches/list](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list)
+
+
+- [GET api/statuses/home_timeline](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline)
+ - Alias: `GET api/statuses/friends_timeline`
+- [GET api/statuses/user_timeline](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline)
+- [GET api/statuses/mentions (deprecated)](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-mentions_timeline)
+- [GET api/statuses/show/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id)
+- [POST api/statuses/retweet/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id)
+- [POST api/statuses/destroy/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id)
+- [GET api/statuses/followers (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-list)
+ - Alias: `GET api/statuses/friends`
+
+
+- [GET api/favorites (deprecated)](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-favorites-list)
+ - Unsupported parameters:
+ - `user_id`: Favorites aren't returned for other users than self
+ - `screen_name`: Favorites aren't returned for other users than self
+- [POST api/favorites/create](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-favorites-create)
+- [POST api/favorites/destroy](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-favorites-destroy)
+
+
+- [GET api/lists/list](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list)
+- [GET api/lists/ownerships](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships)
+ - Unsupported parameters:
+ - `slug`
+ - `owner_screen_name`
+ - `owner_id`
+ - `include_entities`
+- [GET api/lists/statuses](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses)
+ - Unsupported parameters:
+ - `screen_name`
+ - `count`
+- [GET api/lists/subscriptions](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions)
+- [POST api/lists/update](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update)
+ - Unsupported parameters:
+ - `slug`
+ - `name`
+ - `mode`
+ - `description`
+ - `owner_screen_name`
+ - `owner_id`
+- [POST api/lists/create](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create)
+ - Unsupported parameters:
+ - `mode`
+ - `description`
+- [POST api/lists/destroy](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy)
+ - Unsupported parameters:
+ - `owner_screen_name`
+ - `owner_id`
+ - `slug`
+
+- [GET api/blocks/list](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list)
+
+
+- [GET api/friendships/incoming](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming)
+ - Unsupported parameters
+ - `stringify_ids`
+- [GET api/followers/ids](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids)
+ - Unsupported parameters:
+ - `user_id`: Relationships aren't returned for other users than self
+ - `screen_name`: Relationships aren't returned for other users than self
+- [GET api/friends/ids](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids)
+ - Unsupported parameters:
+ - `user_id`: Relationships aren't returned for other users than self
+ - `screen_name`: Relationships aren't returned for other users than self
+
+
+- [POST api/friendships/destroy](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy)
+
+
+## Non-implemented endpoints
+
+- [GET oauth/authenticate](https://developer.twitter.com/en/docs/basics/authentication/api-reference/authenticate)
+- [GET oauth/authorize](https://developer.twitter.com/en/docs/basics/authentication/api-reference/authorize)
+- [POST oauth/invalidate_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/invalidate_access_token)
+- [POST oauth2/invalidate_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/invalidate_bearer_token)
+- [POST oauth2/token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/token)
+
+
+- [GET lists/members](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members)
+- [GET lists/members/show](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show)
+- [GET lists/memberships](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships)
+- [GET lists/show](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-show)
+- [GET lists/subscribers](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers)
+- [GET lists/subscribers/show](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers-show)
+- [POST lists/members/create](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create)
+- [POST lists/members/create_all](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all)
+- [POST lists/members/destroy](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy)
+- [POST lists/members/destroy_all](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all)
+- [POST lists/subscribers/create](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create)
+- [POST lists/subscribers/destroy](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-destroy)
+
+
+- [GET followers/list](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-list)
+- [GET friends/list](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-list)
+- [GET friendships/lookup](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup)
+- [GET friendships/no_retweets/ids](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids)
+- [GET friendships/outgoing](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing)
+- [GET friendships/show](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show)
+- [GET users/suggestions (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions)
+- [GET users/suggestions/:slug (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions-slug)
+- [GET users/suggestions/:slug/members (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions-slug-members)
+- [POST friendships/create](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create)
+- [POST friendships/update](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update)
+
+
+- [GET account/settings](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-settings)
+- [GET saved_searches/show/:id](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-show-id)
+- [GET users/profile_banner](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner)
+- [POST account/remove_profile_banner](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner)
+- [POST account/settings](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-settings)
+- [POST account/update_profile_background_image (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_background_image)
+- [POST account/update_profile_banner](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner)
+- [POST saved_searches/create](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create)
+- [POST saved_searches/destroy/:id](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id)
+
+
+- [GET blocks/ids](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids)
+- [GET mutes/users/ids](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-ids)
+- [GET mutes/users/list](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list)
+- [POST blocks/create](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create)
+- [POST blocks/destroy](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-destroy)
+- [POST mutes/users/create](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create)
+- [POST mutes/users/destroy](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy)
+- [POST users/report_spam](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam)
+
+
+- [GET collections/entries](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-entries)
+- [GET collections/list](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-list)
+- [GET collections/show](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-show)
+- [POST collections/create](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-create)
+- [POST collections/destroy](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-destroy)
+- [POST collections/entries/add](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-add)
+- [POST collections/entries/curate](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-curate)
+- [POST collections/entries/move](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-move)
+- [POST collections/entries/remove](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-remove)
+- [POST collections/update](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-update)
+
+
+- [POST statuses/filter](https://developer.twitter.com/en/docs/tweets/filter-realtime/api-reference/post-statuses-filter)
+
+
+- [GET statuses/mentions_timeline](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-mentions_timeline)
+
+
+- [GET favorites/list](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-favorites-list)
+- [GET statuses/lookup](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-lookup)
+- [GET statuses/oembed](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-oembed)
+- [GET statuses/retweeters/ids](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweeters-ids)
+- [GET statuses/retweets/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweets-id)
+- [GET statuses/retweets_of_me](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweets_of_me)
+- [POST statuses/unretweet/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-unretweet-id)
+
+
+- [GET statuses/sample](https://developer.twitter.com/en/docs/tweets/sample-realtime/api-reference/get-statuses-sample)
+
+
+- [GET compliance/firehose](https://developer.twitter.com/en/docs/tweets/compliance/api-reference/compliance-firehose)
+
+
+- [DELETE custom_profiles/destroy.json](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/delete-profile)
+- [GET custom_profiles/:id](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/get-profile)
+- [GET custom_profiles/list](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/get-profile-list)
+- [POST custom_profiles/new.json](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/new-profile)
+
+
+- [DELETE direct_messages/events/destroy](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message-event)
+- [GET direct_messages/events/list](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events)
+- [GET direct_messages/events/show](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-event)
+- [POST direct_messages/events/new (message_create)](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event)
+- [POST direct_messages/indicate_typing](https://developer.twitter.com/en/docs/direct-messages/typing-indicator-and-read-receipts/api-reference/new-typing-indicator)
+- [POST direct_messages/mark_read](https://developer.twitter.com/en/docs/direct-messages/typing-indicator-and-read-receipts/api-reference/new-read-receipt)
+
+
+- [DELETE direct_messages/welcome_messages/destroy](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/delete-welcome-message)
+- [DELETE direct_messages/welcome_messages/rules/destroy](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/delete-welcome-message-rule)
+- [PUT direct_messages/welcome_messages/update](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/update-welcome-message)
+- [GET direct_messages/welcome_messages/list](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/list-welcome-messages)
+- [GET direct_messages/welcome_messages/rules/list](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/list-welcome-message-rules)
+- [GET direct_messages/welcome_messages/rules/show](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message-rule)
+- [GET direct_messages/welcome_messages/show](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message)
+- [POST direct_messages/welcome_messages/new](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message)
+- [POST direct_messages/welcome_messages/rules/new](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message-rule)
+
+
+- [GET media/upload (STATUS)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/get-media-upload-status)
+- [POST media/subtitles/create](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-subtitles-create)
+- [POST media/subtitles/delete](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-subtitles-delete)
+- [POST media/upload (APPEND)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-append)
+- [POST media/upload (FINALIZE)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-finalize)
+- [POST media/upload (INIT)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-init)
+
+
+- [GET trends/available](https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-available)
+- [GET trends/closest](https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-closest)
+- [GET trends/place](https://developer.twitter.com/en/docs/trends/trends-for-location/api-reference/get-trends-place)
+
+
+- [GET geo/id/:place_id](https://developer.twitter.com/en/docs/geo/place-information/api-reference/get-geo-id-place_id)
+- [GET geo/reverse_geocode](https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-reverse_geocode)
+- [GET geo/search](https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search)
-# Friendica API
+# Using the APIs
<!-- markdownlint-disable MD010 MD013 MD024 -->
* [Home](help)
-The Friendica API aims to be compatible with the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public).
+Friendica offers multiple API endpoints to interface with third-party applications:
-Please refer to the linked documentation for further information.
+- [Twitter](help/API-Twitter)
+- [Mastodon](help/API-Mastodon)
+- [Friendica-specific](help/API-Friendica)
+- [GNU Social](help/API-GNU-Social)
-## Implemented API calls
+## Usage
-### General
+### HTTP Method
-#### HTTP Method
-
-API endpoints can restrict the method used to request them.
+API endpoints can restrict the HTTP method used to request them.
Using an invalid method results in HTTP error 405 "Method Not Allowed".
-In this document, the required method is listed after the endpoint name. "*" means every method can be used.
-
-#### Auth
-
-Friendica supports basic http auth and OAuth 1 to authenticate the user to the api.
-
-OAuth settings can be added by the user in web UI under /settings/oauth/
-
-In this document, endpoints which requires auth are marked with "AUTH" after endpoint name
-
-#### Unsupported parameters
-
-* cursor: Not implemented in GNU Social
-* trim_user: Not implemented in GNU Social
-* contributor_details: Not implemented in GNU Social
-* place_id: Not implemented in GNU Social
-* display_coordinates: Not implemented in GNU Social
-* include_rts: To-Do
-* include_my_retweet: Retweets in Friendica are implemented in a different way
-
-#### Different behaviour
+### Authentication
-* screen_name: The nick name in friendica is only unique in each network but not for all networks. The users are searched in the following priority: Friendica, StatusNet/GNU Social, Diaspora, pump.io, Twitter. If no contact was found by this way, then the first contact is taken.
-* include_entities: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.
+Friendica supports basic HTTP Auth and OAuth 1 to authenticate the user to the APIs.
-#### Return values
+OAuth settings can be added by the user in web UI under [/settings/oauth/](/settings/oauth/).
-* cid: Contact id of the user (important for "contact_allow" and "contact_deny")
-* network: network of the user
-
-#### Errors
+### Errors
When an error occurs in API call, an HTTP error code is returned, with an error message
Usually:
json:
```json
- {
- "error": "Specific error message",
- "request": "API path requested",
- "code": "HTTP error code"
- }
-```
-
-xml:
-
-```xml
- <status>
- <error>Specific error message</error>
- <request>API path requested</request>
- <code>HTTP error code</code>
- </status>
-```
-
----
-
-### account/rate_limit_status (*; AUTH)
-
----
-
-### account/verify_credentials (*; AUTH)
-
-#### Parameters
-
-* skip_status: Don't show the "status" field. (Default: false)
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
----
-
-### conversation/show (*; AUTH)
-
-Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
-
-#### Parameter
-
-* id: id of the post
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* include_rts
-* trim_user
-* contributor_details
-
----
-
-### direct_messages (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* getText: Defines the format of the status field. Can be "html" or "plain"
-* include_entities: "true" shows entities for pictures and links (Default: false)
-* friendica_verbose: "true" enables different error returns (default: "false")
-
-#### Unsupported parameters
-
-* skip_status
-
----
-
-### direct_messages/all (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* getText: Defines the format of the status field. Can be "html" or "plain"
-* friendica_verbose: "true" enables different error returns (default: "false")
-
----
-
-### direct_messages/conversation (*; AUTH)
-
-Shows all direct messages of a conversation
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* getText: Defines the format of the status field. Can be "html" or "plain"
-* uri: URI of the conversation
-* friendica_verbose: "true" enables different error returns (default: "false")
-
----
-
-### direct_messages/sent (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* getText: Defines the format of the status field. Can be "html" or "plain"
-* include_entities: "true" shows entities for pictures and links (Default: false)
-* friendica_verbose: "true" enables different error returns (default: "false")
-
----
-
-### direct_messages/new (POST,PUT; AUTH)
-
-#### Parameters
-
-* user_id: id of the user
-* screen_name: screen name (for technical reasons, this value is not unique!)
-* text: The message
-* replyto: ID of the replied direct message
-* title: Title of the direct message
-
----
-
-### direct_messages/destroy (POST,DELETE; AUTH)
-
-#### Parameters
-
-* id: id of the message to be deleted
-* include_entities: optional, currently not yet implemented
-* friendica_parenturi: optional, can be used for increased safety to delete only intended messages
-* friendica_verbose: "true" enables different error returns (default: "false")
-
-#### Return values
-
-On success:
-
-* JSON return as defined for Twitter API not yet implemented
-* on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
-
-On error:
-HTTP 400 BadRequest
-
-* on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
-
----
-
-### externalprofile/show (*)
-
-#### Parameters
-
-* profileurl: profile url
-
----
-
-### favorites (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* user_id
-* screen_name
-
-Favorites aren't displayed to other users, so "user_id" and "screen_name" are unsupported.
-Set this values will result in an empty array.
-
----
-
-### favorites/create (POST,PUT; AUTH)
-
-#### Parameters
-
-* id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
----
-
-### favorites/destroy (POST,DELETE; AUTH)
-
-#### Parameters
-
-* id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
----
-
-### followers/ids (*; AUTH)
-
-#### Parameters
-
-* stringify_ids: Send id numbers as text (true) or integers (false)? (default: false)
-
-#### Unsupported parameters
-
-* user_id
-* screen_name
-* cursor
-
-Friendica doesn't allow showing the followers of other users.
-
----
-
-### friends/ids (*; AUTH)
-
-#### Parameters
-
-* stringify_ids: Send the id numbers as text (true) or integers (false)? (default: false)
-
-#### Unsupported parameters
-
-* user_id
-* screen_name
-* cursor
-
-Friendica doesn't allow showing the friends of other users.
-
----
-
-### help/test (*)
-
----
-
-### lists/ownerships (*; AUTH)
-
-#### Parameters
-
-* list_id: ID of the list
-* count: Items per page
-* page: Page number
-* since_id: Minimum ID
-* max_id: Maximum ID
-
-#### Unsupported parameters
-
-* slug
-* owner_screen_name
-* owner_id
-* include_entities
-* include_rts
-
----
-
-### lists/destroy (POST; AUTH)
-
-#### Parameters
-
-* list_id: ID of the list
-
-#### Unsupported parameters
-
-* owner_screen_name
-* owner_id
-* slug
-
----
-
-### lists/create (POST; AUTH)
-
-#### Parameters
-
-* name: name of the list
-
-#### Unsupported parameters
-
-* mode
-* description
-
----
-
-### lists/update (POST; AUTH)
-
-#### Parameters
-
-* list_id: ID of the list
-* name: name of the list
-
-#### Unsupported parameters
-
-* slug
-* name
-* mode
-* description
-* owner_screen_name
-* owner_id
-
----
-
-### lists/statuses (*; AUTH)
-
-#### Parameters
-
-* user_id: ID of the user for whom to return results.
-
-#### Unsupported parameters
-
-* screen_name
-* count
-* cursor
-
----
-
-### media/upload (POST,PUT; AUTH)
-
-#### Parameters
-
-* media: image data
-
-#### Return values
-
-Object of:
-
-* media_id: a media identifier (integer)
-* media_id_string: a media identifier (string)
-* size: size in byte
-* image.w: image width
-* image.h: image height
-* image.image_type: image mime type
-* image.friendica_preview_url: image preview url
-
----
-
-### media/metadata/create (POST,PUT; AUTH)
-
-#### Parameters
-
-Parameters are sent as JSON object:
-
-```
{
- "media_id":"1234",
- "alt_text": {
- "text":"Here comes the description"
- }
+ "error": "Specific error message",
+ "request": "API path requested",
+ "code": "HTTP error code"
}
```
-#### Return values
-
-None
-
----
-
-### oauth/request_token (*)
-
-#### Parameters
-
-* oauth_callback
-
-#### Unsupported parameters
-
-* x_auth_access_type
-
----
-
-### oauth/access_token (*)
-
-#### Parameters
-
-* oauth_verifier
-
-#### Unsupported parameters
-
-* x_auth_password
-* x_auth_username
-* x_auth_mode
-
----
-
-### statuses/destroy (POST,DELETE; AUTH)
-
-#### Parameters
-
-* id: message number
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* trim_user
-
----
-
-### statuses/followers (*; AUTH)
-
-#### Parameters
-
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
----
-
-### statuses/friends (*; AUTH)
-
-#### Parameters
-
-* include_entities: "true" shows entities for pictures and links (Default: false)
-* count: how many items should be shown (Default: 20)
-
----
-
-### blocks/list (*; AUTH)
-
-#### Parameters
-
-* include_entities: "true" shows entities for pictures and links (Default: false)
-* count: Items per page (default: 20).
-* page: page number
-
-#### Unsupported parameters
-
-* cursor
-* skip_status
-
----
-
-### statuses/friends_timeline (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* exclude_replies: don't show replies (default: false)
-* conversation_id: Shows all statuses of a given conversation.
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* include_rts
-* trim_user
-* contributor_details
-
----
-
-### statuses/home_timeline (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* exclude_replies: don't show replies (default: false)
-* conversation_id: Shows all statuses of a given conversation.
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* include_rts
-* trim_user
-* contributor_details
-
----
-
-### statuses/mentions (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* include_rts
-* trim_user
-* contributor_details
-
----
-
-### statuses/public_timeline (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* exclude_replies: don't show replies (default: false)
-* conversation_id: Shows all statuses of a given conversation.
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* trim_user
-
----
-
-### statuses/networkpublic_timeline (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
----
-
-### statuses/replies (*; AUTH)
-
-#### Parameters
-
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* include_rts
-* trim_user
-* contributor_details
-
----
-
-### statuses/retweet (POST,PUT; AUTH)
-
-#### Parameters
-
-* id: message number
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* trim_user
-
----
-
-### statuses/show (*; AUTH)
-
-#### Parameters
-
-* id: message number
-* conversation: if set to "1" show all messages of the conversation with the given id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* include_my_retweet
-* trim_user
-
----
-
-### statuses/update, statuses/update_with_media
-
-#### Parameters
-
-* title: Title of the status
-* status: Status in text format
-* htmlstatus: Status in HTML format
-* in_reply_to_status_id
-* lat: latitude
-* long: longitude
-* media: image data
-* source: Application name
-* group_allow
-* contact_allow
-* group_deny
-* contact_deny
-* network
-* include_entities: "true" shows entities for pictures and links (Default: false)
-* media_ids: (By now only a single value, no array)
-
-#### Unsupported parameters
-
-* trim_user
-* place_id
-* display_coordinates
-
----
-
-### statuses/user_timeline (*; AUTH)
-
-#### Parameters
-
-* user_id: id of the user
-* screen_name: screen name (for technical reasons, this value is not unique!)
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* exclude_replies: don't show replies (default: false)
-* conversation_id: Shows all statuses of a given conversation.
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* include_rts
-* trim_user
-* contributor_details
-
----
-
-### Return values for statuses/* api calls
-
-Returned status object is conform to GNU Social/Twitter api.
-
-Friendica adds some addictional fields:
-
-- author: a user object, it's the author of the item. In case of a reshare for legacy reasons the "user" field doesn't show the real author. This field always contains the real author of a post.
-- owner: a user object, it's the owner of the item.
-- private: boolean, true if the item is marked as private
-- activities: map with activities related to the item. Every activity is a list of user objects.
-- comments: comment numbers
-
-This properties are prefixed with "friendica_" in JSON responses and namespaced under "http://friendi.ca/schema/api/1/" in XML responses
-
-JSON:
-
-```json
-[
- {
- // ...
- 'friendica_author' : {
- // user object
- },
- 'friendica_owner' : {
- // user object
- },
- 'friendica_private' : true,
- 'friendica_activities': {
- 'like': [
- {
- // user object
- },
- // ...
- ],
- 'dislike': [],
- 'attendyes': [],
- 'attendno': [],
- 'attendmaybe': []
- },
- 'friendica_comments': 12
- },
- // ...
-]
-```
-
-XML:
-
-```xml
-<statuses xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" xmlns:friendica="http://friendi.ca/schema/api/1/" xmlns:georss="http://www.georss.org/georss">
- <status>
- <!-- ... -->
- <friendica:owner><!-- user object --></friendica:owner>
- <friendica:private>true</friendica:private>
- <friendica:activities>
- <friendica:like>
- <user>
- <!-- user object -->
- </user>
- <!-- ... --->
- </friendica:like>
- <friendica:dislike/>
- <friendica:attendyes/>
- <friendica:attendno/>
- <friendica:attendmaybe/>
- </friendica:activities>
- <friendica:comments>21</friendica:comments>
- </status>
- <!-- ... -->
-</statuses>
-```
-
-
----
-
-### statusnet/config (*)
-
----
-
-### statusnet/conversation (*; AUTH)
-
-It shows all direct answers (excluding the original post) to a given id.
-
-#### Parameter
-
-* id: id of the post
-* count: Items per page (default: 20)
-* page: page number
-* since_id: minimum id
-* max_id: maximum id
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
----
-
-### statusnet/version (*)
-
-#### Unsupported parameters
-
-* user_id
-* screen_name
-* cursor
-
-Friendica doesn't allow showing followers of other users.
-
----
-
-### search (*; AUTH)
-
-#### Parameters
-
-* q: search query
-* page: the page number (starting at 1) to return
-* rpp: the number of statuses to return per page
-* count: alias for the rpp parameter
-* since_id: returns statuses with ids greater than the given id
-* max_id: returns statuses with ids lower or equal to the given id
-* exclude_replies: don't show replies (default: false)
-
-#### Unsupported parameters
-
-* geocode
-* lang
-* locale
-* result_type
-* until
-* include_entities
-
----
-
-### search/tweets (*; AUTH)
-
-This is an alias for `search`.
-
----
-
-### saved_searches/list (*; AUTH)
-
-This call does not have any parameter.
-
----
-
-### users/search (*)
-
-#### Parameters
-
-* q: name of the user
-
-#### Unsupported parameters
-
-* page
-* count
-* include_entities
-
----
-
-### users/show (*)
-
-#### Parameters
-
-* user_id: id of the user
-* screen_name: screen name (for technical reasons, this value is not unique!)
-* include_entities: "true" shows entities for pictures and links (Default: false)
-
-#### Unsupported parameters
-
-* user_id
-* screen_name
-* cursor
-
-Friendica doesn't allow showing friends of other users.
-
----
-
-### users/lookup (*; AUTH)
-
-#### Parameters
-
-* user_id: list of ids to lookup
-
-#### Unsupported parameters
-
-* screen_name
-* include_entities
-
----
-
-### account/update_profile_image (POST; AUTH)
-
-#### Parameters
-
-* image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
-* profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
-
-uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
-
-#### Return values
-
-On success:
-
-* JSON return: returns the updated user details (see account/verify_credentials)
-
-On error:
-
-* 403 FORBIDDEN: if not authenticated
-* 400 BADREQUEST: "no media data submitted", "profile_id not available"
-* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
- "image size exceeds Friendica Config setting (uploaded size: x)",
- "unable to process image data",
- "image upload failed"
-
----
-
-### account/update_profile (POST; AUTH)
-
-#### Parameters
-
-* name (optional): full name of the user
-* description (optional): a description of the user
-
-#### Unsupported parameters
-
-* url
-* location
-* profile_link_color
-* include_entities
-* skip_status
-
----
-
-### friendships/incoming (*; AUTH)
-
-#### Unsupported parameters
-
-* cursor
-* stringify_ids
-
-## Implemented API calls (not compatible with other APIs)
-
----
-
-### friendica/activity/[verb]
-
-#### parameters
-
-* id: item id
-
-Add or remove an activity from an item.
-'verb' can be one of:
-
-* like
-* dislike
-* attendyes
-* attendno
-* attendmaybe
-
-To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
-Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
-Attend verbs should be used only with event-related items (there is no check at the moment)
-
-#### Return values
-
-On success:
-json:
-
-```"ok"```
-
-xml:
-
-```<ok>true</ok>```
-
-On error:
-HTTP 400 BadRequest
-
----
-
-### friendica/group_show (*; AUTH)
-
-Return all or a specified group of the user with the containing contacts as array.
-
-#### Parameters
-
-* gid: optional, if not given, API returns all groups of the user
-
-#### Return values
-
-Array of:
-
-* name: name of the group
-* gid: id of the group
-* user: array of group members (return from api_get_user() function for each member)
-
----
-
-### friendica/group_delete (POST,DELETE; AUTH)
-
-delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
-
-#### Parameters
-
-* gid: id of the group to be deleted
-* name: name of the group to be deleted
-
-#### Return values
-
-Array of:
-
-* success: true if successfully deleted
-* gid: gid of the deleted group
-* name: name of the deleted group
-* status: „deleted“ if successfully deleted
-* wrong users: empty array
-
----
-
-### friendica/group_create (POST,PUT; AUTH)
-
-Create the group with the posted array of contacts as members.
-
-#### Parameters
-
-* name: name of the group to be created
-
-#### POST data
-
-JSON data as Array like the result of "users/group_show":
-
-* gid
-* name
-* array of users
-
-#### Return values
-
-Array of:
-
-* success: true if successfully created or reactivated
-* gid: gid of the created group
-* name: name of the created group
-* status: „missing user“ | „reactivated“ | „ok“
-* wrong users: array of users, which were not available in the contact table
-
----
-
-### friendica/group_update (POST)
-
-Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).
-
-#### Parameters
-
-* gid: id of the group to be changed
-* name: name of the group to be changed
-
-#### POST data
-
-JSON data as array like the result of „users/group_show“:
-
-* gid
-* name
-* array of users
-
-#### Return values
-
-Array of:
-
-* success: true if successfully updated
-* gid: gid of the changed group
-* name: name of the changed group
-* status: „missing user“ | „ok“
-* wrong users: array of users, which were not available in the contact table
-
----
-
-### friendica/notifications (GET)
-
-Return last 50 notification for current user, ordered by date with unseen item on top
-
-#### Parameters
-
-none
-
-#### Return values
-
-Array of:
-
-* id: id of the note
-* type: type of notification as int (see NOTIFY_* constants in boot.php)
-* name: full name of the contact subject of the note
-* url: contact's profile url
-* photo: contact's profile photo
-* date: datetime string of the note
-* timestamp: timestamp of the node
-* date_rel: relative date of the note (eg. "1 hour ago")
-* msg: note message in bbcode
-* msg_html: note message in html
-* msg_plain: note message in plain text
-* link: link to note
-* seen: seen state: 0 or 1
-
----
-
-### friendica/notifications/seen (POST)
-
-Set note as seen, returns item object if possible
-
-#### Parameters
-
-id: id of the note to set seen
-
-#### Return values
-
-If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
-
-If the note is not linked to an item, a success status is returned:
-
-* `success` (json) | `<status>success</status>` (xml)
-
----
-
-### friendica/photo (*; AUTH)
-
-#### Parameters
-
-* photo_id: Resource id of a photo.
-* scale: (optional) scale value of the photo
-
-Returns data of a picture with the given resource.
-If 'scale' isn't provided, returned data include full url to each scale of the photo.
-If 'scale' is set, returned data include image data base64 encoded.
-
-possibile scale value are:
-
-* 0: original or max size by server settings
-* 1: image with or height at <= 640
-* 2: image with or height at <= 320
-* 3: thumbnail 160x160
-* 4: Profile image at 300x300
-* 5: Profile image at 80x80
-* 6: Profile image at 48x48
-
-An image used as profile image has only scale 4-6, other images only 0-3
-
-#### Return values
-
-json:
-
-```json
- {
- "id": "photo id"
- "created": "date(YYYY-MM-DD HH:MM:SS)",
- "edited": "date(YYYY-MM-DD HH:MM:SS)",
- "title": "photo title",
- "desc": "photo description",
- "album": "album name",
- "filename": "original file name",
- "type": "mime type",
- "height": "number",
- "width": "number",
- "profile": "1 if is profile photo",
- "link": {
- "<scale>": "url to image"
- ...
- },
- // if 'scale' is set
- "datasize": "size in byte",
- "data": "base64 encoded image data"
- }
-```
-
xml:
```xml
- <photo>
- <id>photo id</id>
- <created>date(YYYY-MM-DD HH:MM:SS)</created>
- <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
- <title>photo title</title>
- <desc>photo description</desc>
- <album>album name</album>
- <filename>original file name</filename>
- <type>mime type</type>
- <height>number</height>
- <width>number</width>
- <profile>1 if is profile photo</profile>
- <links type="array">
- <link type="mime type" scale="scale number" href="image url"/>
- ...
- </links>
- </photo>
+<status>
+ <error>Specific error message</error>
+ <request>API path requested</request>
+ <code>HTTP error code</code>
+</status>
```
----
-
-### friendica/photos/list (*; AUTH)
-
-Returns a list of all photo resources of the logged in user.
-
-#### Return values
-
-json:
-
-```json
- [
- {
- id: "resource_id",
- album: "album name",
- filename: "original file name",
- type: "image mime type",
- thumb: "url to thumb sized image"
- },
- ...
- ]
-```
-
-xml:
-
-```xml
- <photos type="array">
- <photo id="resource_id"
- album="album name"
- filename="original file name"
- type="image mime type">
- "url to thumb sized image"
- </photo>
- ...
- </photos>
-```
-
----
-
-### friendica/photoalbum/delete (POST,DELETE; AUTH)
-
-#### Parameters
-
-* album: name of the album to be deleted
-
-deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
-
-#### Return values
-
-On success:
-
-* JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
-
-On error:
-
-* 403 FORBIDDEN: if not authenticated
-* 400 BADREQUEST: "no albumname specified", "album not available"
-* 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
-
----
-
-### friendica/photoalbum/update (POST,PUT; AUTH)
-
-#### Parameters
-
-* album: name of the album to be updated
-* album_new: new name of the album
-
-changes the album name to album_new for all photos in album
-
-#### Return values
-
-On success:
-
-* JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
-
-On error:
-
-* 403 FORBIDDEN: if not authenticated
-* 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
-* 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
-
----
-
-### friendica/photo/create (POST; AUTH)
-
-### friendica/photo/update (POST; AUTH)
-
-#### Parameters
-
-* photo_id (optional): if specified the photo with this id will be updated
-* media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
-* desc (optional): description for the photo, updated when photo_id is specified
-* album: name of the album to be deleted (always necessary)
-* album_new (optional): can be used to change the album of a single photo if photo_id is specified
-* allow_cid/allow_gid/deny_cid/deny_gid (optional): on create: empty string or omitting = public photo, specify in format '```<x><y><z>```' for private photo;
- on update: keys need to be present with empty values for changing a private photo to public
-
-both calls point to one function for creating AND updating photos.
-Saves data for the scales 0-2 to database (see above for scale description).
-Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
-Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group.
-Currently it is best to inform user that updating rights is not the right way to do this, and offer a solution to add photo as a new photo with the new rights instead.
-
-#### Return values
-
-On success:
-
-* new photo uploaded: JSON return with photo data (see friendica/photo)
-* photo updated - changed photo data: JSON return with photo data (see friendica/photo)
-* photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
-* photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
-
-On error:
-
-* 403 FORBIDDEN: if not authenticated
-* 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
-* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
- "image size exceeds Friendica Config setting (uploaded size: x)",
- "unable to process image data",
- "image upload failed",
- "unknown error - uploading photo failed, see Friendica log for more information",
- "unknown error - update photo entry in database failed",
- "unknown error - this error on uploading or updating a photo should never happen"
-
----
-
-### friendica/photo/delete (DELETE; AUTH)
-
-#### Parameters
-
-* photo_id: id of the photo to be deleted
-
-deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
-Sets item table entries for this photo to deleted = 1
-
-#### Return values
-
-On success:
-
-* JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
-
-On error:
-
-* 403 FORBIDDEN: if not authenticated
-* 400 BADREQUEST: "no photo_id specified", "photo not available"
-* 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
-
----
-
-### friendica/direct_messages_setseen (GET; AUTH)
-
-#### Parameters
-
-* id: id of the message to be updated as seen
-
-#### Return values
-
-On success:
-
-* JSON return {"result":"ok","message":"message set to seen"}
-
-On error:
-
-* different JSON returns {"result":"error","message":"xyz"}
-
----
-
-### friendica/direct_messages_search (GET; AUTH)
-
-#### Parameters
-
-* searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
-
-#### Return values
-
-Returns only tested with JSON, XML might work as well.
-
-On success:
-
-* JSON return {"success":"true","search_results": array of found messages}
-* JSOn return {"success":"false","search_results":"nothing found"}
-
-On error:
-
-* different JSON returns {"result":"error","message":"searchstring not specified"}
-
----
-
-### friendica/profile/show (GET; AUTH)
-
-show data of all profiles or a single profile of the authenticated user
-
-#### Parameters
-
-* profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
-
-#### Return values
-
-On success: Array of:
-
-* multi_profiles: true if user has activated multi_profiles
-* global_dir: URL of the global directory set in server settings
-* friendica_owner: user data of the authenticated user
-* profiles: array of the profile data
-
-On error:
-HTTP 403 Forbidden: when no authentication was provided
-HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
-
-General description of profile data in API returns:
-
-* profile_id
-* profile_name
-* is_default: true if this is the public profile
-* hide_friends: true if friends are hidden
-* profile_photo
-* profile_thumb
-* publish: true if published on the server's local directory
-* net_publish: true if published to global_dir
-* description ... homepage: different data fields from 'profile' table in database
-* users: array with the users allowed to view this profile (empty if is_default=true)
-
----
-
-## Not Implemented API calls
-
-The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
-
-* statuses/retweets_of_me
-* friendships/create
-* friendships/destroy
-* friendships/exists
-* friendships/show
-* account/update_profile_background_image
-* blocks/create
-* blocks/destroy
-
-The following API calls from the Twitter API are not implemented in either Friendica or GNU Social:
-
-* statuses/mentions_timeline
-* statuses/retweets/:id
-* statuses/oembed
-* statuses/retweeters/ids
-* statuses/lookup
-* direct_messages/show
-* friendships/no_retweets/ids
-* friendships/outgoing
-* friendships/update
-* friends/list
-* friendships/lookup
-* account/settings
-* account/update_delivery_device
-* blocks/ids
-* users/show
-* users/search
-* account/remove_profile_banner
-* account/update_profile_banner
-* users/profile_banner
-* mutes/users/create
-* mutes/users/destroy
-* mutes/users/ids
-* mutes/users/list
-* users/suggestions/:slug
-* users/suggestions
-* users/suggestions/:slug/members
-* favorites/list
-* lists/list
-* lists/members/destroy
-* lists/memberships
-* lists/subscribers
-* lists/subscribers/create
-* lists/subscribers/show
-* lists/subscribers/destroy
-* lists/members/create_all
-* lists/members/show
-* lists/members
-* lists/members/create
-* lists/show
-* lists/subscriptions
-* lists/members/destroy_all
-* saved_searches/show/:id
-* saved_searches/create
-* saved_searches/destroy/:id
-* geo/id/:place_id
-* geo/reverse_geocode
-* geo/search
-* geo/place
-* trends/place
-* trends/available
-* help/configuration
-* help/languages
-* help/privacy
-* help/tos
-* trends/closest
-* users/report_spam
-
----
-
----
-
## Usage Examples
### BASH / cURL
projects / friendica.git / commitdiff