- {
- "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
-
----
-
-### 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
-
----
-
-### 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
-
-#### 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 175x175
-* 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>
-```
-
----
-
-### 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"
- },
- ...
- ]