doc/API-Friendica.md

   1 # Friendica API
   2
   3 * [Home](help)
   4   * [Using the APIs](help/api)
   5
   6 ## Overview
   7
   8 Friendica provides the following specific endpoints.
   9
  10 Authentication is the same as described in [Using the APIs](help/api#Authentication).
  11
  12 ## Entities
  13
  14 These endpoints uses the [Friendica API entities](help/API-Entities).
  15
  16 ## Endpoints
  17
  18 ### GET api/friendica/events
  19
  20 Returns a list of [Event](help/API-Entities#Event) entities for the current logged in user.
  21
  22 #### Parameters
  23
  24 - `since_id`: (optional) minimum event id for pagination
  25 - `count`: maximum number of items returned, default 20
  26
  27 ### POST api/friendica/event_create
  28
  29 Create a new event for the current logged in user.
  30
  31 #### Parameters
  32
  33 - `id` : (optional) id of event, event will be amended if supplied
  34 - `name` : name of the event (required)
  35 - `start_time` : start of the event (ISO), required
  36 - `end_time` : (optional) end of the event, event is open end, if not supplied
  37 - `desc` : (optional) description of the event
  38 - `place` : (optional) location of the event
  39 - `publish` : (optional) create message for event
  40 - `allow_cid` : (optional) ACL-formatted list of allowed contact ids if private event
  41 - `allow_gid` : (optional) ACL-formatted list of disallowed contact ids if private event
  42 - `deny_cid` : (optional) ACL-formatted list of allowed circle ids if private event
  43 - `deny_gid` : (optional) ACL-formatted list of disallowed circle ids if private event
  44
  45 ### POST api/friendica/event_delete
  46
  47 Delete event from calendar (not the message)
  48
  49 #### Parameters
  50
  51 - `id` : id of event to be deleted
  52
  53 ### GET api/externalprofile/show
  54
  55 Returns a [Contact](help/API-Entities#Contact) entity for the provided profile URL.
  56
  57 #### Parameters
  58
  59 - `profileurl`: Profile URL
  60
  61 ### GET api/statuses/public_timeline
  62
  63 Returns a list of public [Items](help/API-Entities#Item) posted on this node.
  64 Equivalent of the local community page.
  65
  66 #### Parameters
  67
  68 * `count`: Items per page (default: 20)
  69 * `page`: page number
  70 * `since_id`: minimum id
  71 * `max_id`: maximum id
  72 * `exclude_replies`: don't show replies (default: false)
  73 * `conversation_id`: Shows all statuses of a given conversation.
  74 * `include_entities`: "true" shows entities for pictures and links (Default: false)
  75
  76 #### Unsupported parameters
  77
  78 * `trim_user`
  79
  80 ### GET api/statuses/networkpublic_timeline
  81
  82 Returns a list of public [Items](help/API-Entities#Item) this node is aware of.
  83 Equivalent of the global community page.
  84
  85 #### Parameters
  86
  87 * `count`: Items per page (default: 20)
  88 * `page`: page number
  89 * `since_id`: minimum id
  90 * `max_id`: maximum id
  91 * `exclude_replies`: don't show replies (default: false)
  92 * `conversation_id`: Shows all statuses of a given conversation.
  93 * `include_entities`: "true" shows entities for pictures and links (Default: false)
  94
  95 ### GET api/statuses/replies
  96
  97 #### Parameters
  98
  99 * `count`: Items per page (default: 20)
 100 * `page`: page number
 101 * `since_id`: minimum id
 102 * `max_id`: maximum id
 103 * `include_entities`: "true" shows entities for pictures and links (Default: false)
 104
 105 #### Unsupported parameters
 106
 107 * `include_rts`
 108 * `trim_user`
 109 * `contributor_details`
 110
 111 ---
 112
 113 ### GET api/conversation/show
 114
 115 Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
 116
 117 #### Parameters
 118
 119 * `id`: id of the post
 120 * `count`: Items per page (default: 20)
 121 * `page`: page number
 122 * `since_id`: minimum id
 123 * `max_id`: maximum id
 124 * `include_entities`: "true" shows entities for pictures and links (Default: false)
 125
 126 #### Unsupported parameters
 127
 128 * `include_rts`
 129 * `trim_user`
 130 * `contributor_details`
 131
 132 ### GET api/statusnet/conversation
 133
 134 Alias of [`api/conversation/show`](#GET+api%2Fconversation%2Fshow).
 135
 136 ### GET api/statusnet/config
 137
 138 Returns the public Friendica node configuration.
 139
 140 ### GET api/gnusocial/config
 141
 142 Alias of [`api/statusnet/config`](#GET+api%2Fstatusnet%2Fconfig).
 143
 144 ### GET api/statusnet/version
 145
 146 Returns a fake static StatusNet protocol version.
 147
 148 ### GET api/gnusocial/version
 149
 150 Alias of [`api/statusnet/version`](#GET+api%2Fstatusnet%2Fversion).
 151
 152 ---
 153
 154 ### POST api/friendica/activity/[verb]
 155
 156 Add or remove an activity from an item.
 157 'verb' can be one of:
 158
 159 * `like`
 160 * `dislike`
 161 * `attendyes`
 162 * `attendno`
 163 * `attendmaybe`
 164
 165 To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
 166 Attend verbs disable each other: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
 167 Attend verbs should be used only with event-related items (there is no check at the moment).
 168
 169 #### Parameters
 170
 171 * `id`: item id
 172
 173 #### Return values
 174
 175 On success:
 176 json:
 177
 178 ```"ok"```
 179
 180 xml:
 181
 182 ```<ok>true</ok>```
 183
 184 On error:
 185 HTTP 400 BadRequest
 186
 187 ---
 188
 189 ### GET api/direct_messages
 190
 191 Deprecated Twitter received direct message list endpoint.
 192
 193 #### Parameters
 194
 195 * `count`: Items per page (default: 20)
 196 * `page`: page number
 197 * `since_id`: minimum id
 198 * `max_id`: maximum id
 199 * `getText`: Defines the format of the status field. Can be "html" or "plain"
 200 * `include_entities`: "true" shows entities for pictures and links (Default: false)
 201 * `friendica_verbose`: "true" enables different error returns (default: "false")
 202
 203 #### Unsupported parameters
 204
 205 * `skip_status`
 206
 207 ### GET api/direct_messages/all
 208
 209 Returns all [Private Messages](help/API-Entities#Private+message).
 210
 211 #### Parameters
 212
 213 * `count`: Items per page (default: 20)
 214 * `page`: page number
 215 * `since_id`: minimum id
 216 * `max_id`: maximum id
 217 * `getText`: Defines the format of the status field. Can be "html" or "plain"
 218 * `friendica_verbose`: "true" enables different error returns (default: "false")
 219
 220 ### GET api/direct_messages/conversation
 221
 222 Returns all replies of a single private message conversation. Returns [Private Messages](help/API-Entities#Private+message)
 223
 224 #### Parameters
 225
 226 * `count`: Items per page (default: 20)
 227 * `page`: page number
 228 * `since_id`: minimum id
 229 * `max_id`: maximum id
 230 * `getText`: Defines the format of the status field. Can be "html" or "plain"
 231 * `uri`: URI of the conversation
 232 * `friendica_verbose`: "true" enables different error returns (default: "false")
 233
 234 ### GET api/direct_messages/sent
 235
 236 Deprecated Twitter sent direct message list endpoint. Returns [Private Messages](help/API-Entities#Private+message).
 237
 238 #### Parameters
 239
 240 * `count`: Items per page (default: 20)
 241 * `page`: page number
 242 * `since_id`: minimum id
 243 * `max_id`: maximum id
 244 * `getText`: Defines the format of the status field. Can be "html" or "plain"
 245 * `include_entities`: "true" shows entities for pictures and links (Default: false)
 246 * `friendica_verbose`: "true" enables different error returns (default: "false")
 247
 248
 249 ### POST api/direct_messages/new
 250
 251 Deprecated Twitter direct message submission endpoint.
 252
 253 #### Parameters
 254
 255 * `user_id`: id of the user
 256 * `screen_name`: screen name (for technical reasons, this value is not unique!)
 257 * `text`: The message
 258 * `replyto`: ID of the replied direct message
 259 * `title`: Title of the direct message
 260
 261 ### POST api/direct_messages/destroy
 262
 263 Deprecated Twitter direct message deletion endpoint.
 264
 265 #### Parameters
 266
 267 * `id`: id of the message to be deleted
 268 * `include_entities`: optional, currently not yet implemented
 269 * `friendica_parenturi`: optional, can be used for increased safety to delete only intended messages
 270 * `friendica_verbose`: "true" enables different error returns (default: "false")
 271
 272 #### Return values
 273
 274 On success:
 275
 276 * JSON return as defined for Twitter API not yet implemented
 277 * on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
 278
 279 On error:
 280 HTTP 400 BadRequest
 281
 282 * on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
 283
 284 ### GET api/friendica/direct_messages_setseen
 285
 286 #### Parameters
 287
 288 * `id`: id of the message to be updated as seen
 289
 290 #### Return values
 291
 292 On success:
 293
 294 * JSON return `{"result": "ok", "message": "message set to seen"}`
 295
 296 On error:
 297
 298 * different JSON returns `{"result": "error", "message": "xyz"}`
 299
 300
 301 ### GET api/friendica/direct_messages_search (GET; AUTH)
 302
 303 Returns [Private Messages](help/API-Entities#Private+message) matching the provided search string.
 304
 305 #### Parameters
 306
 307 * `searchstring`: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
 308 * `getText` (optional): `plain`|`html` If omitted, the title is prepended to the plaintext body in the `text` attribute of the private message objects.
 309 * `getUserObjects` (optional): `true`|`false` If `false`, the `sender` and `recipient` attributes of the private message object are absent.
 310
 311 #### Return values
 312
 313 Returns only tested with JSON, XML might work as well.
 314
 315 On success:
 316
 317 * JSON return `{"success":"true", "search_results": array of found messages}`
 318 * JSOn return `{"success":"false", "search_results": "nothing found"}`
 319
 320 On error:
 321
 322 * different JSON returns `{"result": "error", "message": "searchstring not specified"}`
 323
 324 ---
 325
 326 ### GET api/friendica/circle_show
 327
 328 Alternatively: GET api/friendica/group_show (Backward compatibility)
 329
 330 Return all or a specified circle of the user with the containing contacts as array.
 331
 332 #### Parameters
 333
 334 * `gid`: optional, if not given, API returns all circles of the user
 335
 336 #### Return values
 337
 338 Array of:
 339
 340 * `name`: name of the circle
 341 * `gid`: id of the circle
 342 * `user`: array of [Contacts](help/API-Entities#Contact)
 343
 344 ### POST api/friendica/circle_create
 345
 346 Alternatively: POST api/friendica/group_create
 347
 348 Create the circle with the posted array of contacts as members.
 349
 350 #### Parameters
 351
 352 * `name`: name of the circle to be created
 353
 354 #### POST data
 355
 356 JSON data as Array like the result of [GET api/friendica/circle_show](#GET+api%2Ffriendica%2Fcircle_show):
 357
 358 * `gid`
 359 * `name`
 360 * List of [Contacts](help/API-Entities#Contact)
 361
 362 #### Return values
 363
 364 Array of:
 365
 366 * `success`: true if successfully created or reactivated
 367 * `gid`: gid of the created circle
 368 * `name`: name of the created circle
 369 * `status`: "missing user" | "reactivated" | "ok"
 370 * `wrong users`: array of users, which were not available in the contact table
 371
 372 ### POST api/friendica/circle_update
 373
 374 Alternatively: POST api/friendica/group_update
 375
 376 Update the circle with the posted array of contacts as members (post all members of the circle to the call; function will remove members not posted).
 377
 378 #### Parameters
 379
 380 * `gid`: id of the circle to be changed
 381 * `name`: name of the circle to be changed
 382
 383 #### POST data
 384
 385 JSON data as array like the result of [GET api/friendica/circle_show](#GET+api%2Ffriendica%2Fcircle_show):
 386
 387 * `gid`
 388 * `name`
 389 * List of [Contacts](help/API-Entities#Contact)
 390
 391 #### Return values
 392
 393 Array of:
 394
 395 * `success`: true if successfully updated
 396 * `gid`: gid of the changed circle
 397 * `name`: name of the changed circle
 398 * `status`: "missing user" | "ok"
 399 * `wrong users`: array of users, which were not available in the contact table
 400
 401 ### POST api/friendica/circle_delete
 402
 403 Alternatively: POST api/friendica/group_delete
 404
 405 Delete the specified circle of contacts; API call need to include the correct gid AND name of the circle to be deleted.
 406
 407 #### Parameters
 408
 409 * `gid`: id of the circle to be deleted
 410 * `name`: name of the circle to be deleted
 411
 412 #### Return values
 413
 414 Array of:
 415
 416 * `success`: true if successfully deleted
 417 * `gid`: gid of the deleted circle
 418 * `name`: name of the deleted circle
 419 * `status`: "deleted" if successfully deleted
 420 * `wrong users`: empty array
 421
 422 ---
 423
 424 ### GET api/friendica/notifications
 425
 426 Return last 50 [Notifications](help/API-Entities#Notification) for the current user, ordered by date with unseen item on top.
 427
 428 #### Parameters
 429
 430 none
 431
 432 ### POST api/friendica/notifications/seen
 433
 434 Set notification as seen.
 435
 436 #### Parameters
 437
 438 - `id`: id of the notification to set seen
 439
 440 #### Return values
 441
 442 If the note is linked to an item, returns an [Item](help/API-Entities#Item).
 443
 444 Otherwise, a success status is returned:
 445
 446 * `success` (json) | `<status>success</status>` (xml)
 447
 448 ---
 449
 450 ### GET api/friendica/photo
 451
 452 Returns a [Photo](help/API-Entities#Photo).
 453
 454 #### Parameters
 455
 456 * `photo_id`: Resource id of a photo.
 457 * `scale`: (optional) scale value of the photo
 458
 459 Returns data of a picture with the given resource.
 460 If 'scale' isn't provided, returned data include full url to each scale of the photo.
 461 If 'scale' is set, returned data include image data base64 encoded.
 462
 463 possibile scale value are:
 464
 465 * 0: original or max size by server settings
 466 * 1: image with or height at <= 640
 467 * 2: image with or height at <= 320
 468 * 3: thumbnail 160x160
 469 * 4: Profile image at 300x300
 470 * 5: Profile image at 80x80
 471 * 6: Profile image at 48x48
 472
 473 An image used as profile image has only scale 4-6, other images only 0-3
 474
 475 #### Return values
 476
 477 json:
 478
 479 ```json
 480         {
 481                 "id": "photo id",
 482                 "created": "date(YYYY-MM-DD HH:MM:SS)",
 483                 "edited": "date(YYYY-MM-DD HH:MM:SS)",
 484                 "title": "photo title",
 485                 "desc": "photo description",
 486                 "album": "album name",
 487                 "filename": "original file name",
 488                 "type": "mime type",
 489                 "height": "number",
 490                 "width": "number",
 491                 "profile": "1 if is profile photo",
 492                 "link": {
 493                         "<scale>": "url to image",
 494                         ...
 495                 },
 496                 // if 'scale' is set
 497                 "datasize": "size in byte",
 498                 "data": "base64 encoded image data"
 499         }
 500 ```
 501
 502 xml:
 503
 504 ```xml
 505         <photo>
 506                 <id>photo id</id>
 507                 <created>date(YYYY-MM-DD HH:MM:SS)</created>
 508                 <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
 509                 <title>photo title</title>
 510                 <desc>photo description</desc>
 511                 <album>album name</album>
 512                 <filename>original file name</filename>
 513                 <type>mime type</type>
 514                 <height>number</height>
 515                 <width>number</width>
 516                 <profile>1 if is profile photo</profile>
 517                 <links type="array">
 518                 <link type="mime type" scale="scale number" href="image url"/>
 519                         ...
 520                 </links>
 521         </photo>
 522 ```
 523
 524 ### GET api/friendica/photos/list
 525
 526 Returns the API user's [Photo List Items](help/API-Entities#Photo+List+Item).
 527
 528 #### Return values
 529
 530 json:
 531
 532 ```json
 533         [
 534                 {
 535                         "id": "resource_id",
 536                         "album": "album name",
 537                         "filename": "original file name",
 538                         "type": "image mime type",
 539                         "thumb": "url to thumb sized image"
 540                 },
 541                 ...
 542         ]
 543 ```
 544
 545 xml:
 546
 547 ```xml
 548         <photos type="array">
 549                 <photo id="resource_id"
 550                 album="album name"
 551                 filename="original file name"
 552                 type="image mime type">
 553                         "url to thumb sized image"
 554                 </photo>
 555                 ...
 556         </photos>
 557 ```
 558
 559 ### POST api/friendica/photo/create
 560
 561 Alias of [`api/friendica/photo/update`](#POST+api%2Ffriendica%2Fphoto%2Fupdate)
 562
 563 ### POST api/friendica/photo/update
 564
 565 Saves data for the scales 0-2 to database (see above for scale description).
 566 Call adds non-public entries to items table to enable authenticated contacts to comment/like the photo.
 567 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 circle.
 568 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.
 569
 570 #### Parameters
 571
 572 * `photo_id` (optional): if specified the photo with this id will be updated
 573 * `media` (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
 574 * `desc` (optional): description for the photo, updated when photo_id is specified
 575 * `album`: name of the album to be deleted (always necessary)
 576 * `album_new` (optional): can be used to change the album of a single photo if photo_id is specified
 577 * `allow_cid`/`allow_gid`/`deny_cid`/`deny_gid` (optional):
 578     - on create: empty string or omitting = public photo, specify in format ```<x><y><z>``` for private photo
 579         - on update: keys need to be present with empty values for changing a private photo to public
 580
 581 #### Return values
 582
 583 On success:
 584
 585 * new photo uploaded: JSON return with photo data (see [GET api/friendica/photo](#GET+api%2Ffriendica%2Fphoto))
 586 * photo updated - changed photo data: JSON return with photo data (see [GET api/friendica/photo](#GET+api%2Ffriendica%2Fphoto))
 587 * photo updated - changed info: JSON return `{"result": "updated", "message":"Image id 'xyz' has been updated."}`
 588 * photo updated - nothing changed: JSON return `{"result": "cancelled","message": "Nothing to update for image id 'xyz'."}`
 589
 590 On error:
 591
 592 * 403 FORBIDDEN: if not authenticated
 593 * 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
 594 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
 595                         "image size exceeds Friendica Config setting (uploaded size: x)",
 596                         "unable to process image data",
 597                         "image upload failed",
 598                         "unknown error - uploading photo failed, see Friendica log for more information",
 599                         "unknown error - update photo entry in database failed",
 600                         "unknown error - this error on uploading or updating a photo should never happen"
 601
 602 ### POST api/friendica/photo/delete
 603
 604 Deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
 605 Sets item table entries for this photo to deleted = 1.
 606
 607 #### Parameters
 608
 609 * `photo_id`: id of the photo to be deleted
 610
 611 #### Return values
 612
 613 On success:
 614
 615 * JSON return
 616
 617 ```json
 618 {
 619     "result": "deleted",
 620     "message": "photo with id 'xyz' has been deleted from server."
 621 }
 622 ```
 623
 624 On error:
 625
 626 * 403 FORBIDDEN: if not authenticated
 627 * 400 BADREQUEST: "no photo_id specified", "photo not available"
 628 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
 629
 630 ---
 631
 632 ### POST api/friendica/photoalbum/delete
 633
 634 Deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this.
 635
 636 #### Parameters
 637
 638 * `album`: name of the album to be deleted
 639
 640 #### Return values
 641
 642 On success:
 643
 644 * JSON return
 645
 646 ```json
 647 {
 648     "result": "deleted",
 649     "message": "album 'xyz' with all containing photos has been deleted."
 650 }
 651 ```
 652
 653 On error:
 654
 655 * 403 FORBIDDEN: if not authenticated
 656 * 400 BADREQUEST: "no albumname specified", "album not available"
 657 * 500 INTERNALSERVERERROR: "problem with deleting item occurred", "unknown error - deleting from database failed"
 658
 659 ### POST api/friendica/photoalbum/update
 660
 661 Changes the album name to album_new for all photos in album.
 662
 663 #### Parameters
 664
 665 * `album`: name of the album to be updated
 666 * `album_new`: new name of the album
 667
 668 #### Return values
 669
 670 On success:
 671
 672 * JSON return
 673
 674 ```json
 675 {
 676   "result": "updated",
 677   "message":"album 'abc' with all containing photos has been renamed to 'xyz'."
 678 }
 679 ```
 680
 681 On error:
 682
 683 * 403 FORBIDDEN: if not authenticated
 684 * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
 685 * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
 686
 687 ### GET api/friendica/photoalbums
 688
 689 Get a list of photo albums for the user
 690
 691 #### Parameters
 692
 693 None
 694 #### Return values
 695
 696 On success a list of photo album objects:
 697
 698 ```json
 699 [
 700   {
 701     "name": "Wall Photos",
 702     "created": "2023-01-22 02:03:19",
 703     "count": 4
 704   },
 705   {
 706     "name": "Profile photos",
 707     "created": "2022-11-20 14:40:06",
 708     "count": 1
 709   }
 710 ]
 711 ```
 712
 713 ### GET api/friendica/photoalbum
 714
 715 Get a list of images in a photo album
 716 #### Parameters
 717
 718 * `album` (Required): name of the album to be deleted
 719 * `limit` (Optional): Maximum number of items to get, defaults to 50, max 500
 720 * `offset`(Optional): Offset in results to page through total items, defaults to 0
 721 * `latest_first` (Optional): Reverse the order so the most recent images are first, defaults to false
 722
 723 #### Return values
 724
 725 On success:
 726
 727 * JSON return with the list of Photo items
 728
 729 **Example:**
 730 `https://<server>/api/friendica/photoalbum?album=Wall Photos&limit=10&offset=2`
 731
 732 ```json
 733 [
 734   {
 735     "created": "2023-02-14 14:31:06",
 736     "edited": "2023-02-14 14:31:14",
 737     "title": "",
 738     "desc": "",
 739     "album": "Wall Photos",
 740     "filename": "image.png",
 741     "type": "image/png",
 742     "height": 835,
 743     "width": 693,
 744     "datasize": 119523,
 745     "profile": 0,
 746     "allow_cid": "",
 747     "deny_cid": "",
 748     "allow_gid": "",
 749     "deny_gid": "",
 750     "id": "899184972463eb9b2ae3dc2580502826",
 751     "scale": 0,
 752     "media-id": 52,
 753     "scales": [
 754       {
 755         "id": 52,
 756         "scale": 0,
 757         "link": "https://<server>/photo/899184972463eb9b2ae3dc2580502826-0.png",
 758         "width": 693,
 759         "height": 835,
 760         "size": 119523
 761       },
 762       ...
 763     ],
 764     "thumb": "https://<server>/photo/899184972463eb9b2ae3dc2580502826-2.png"
 765   },
 766   ...
 767 ]
 768 ```
 769
 770 ---
 771
 772
 773 ### GET api/friendica/profile/show
 774
 775 Returns the [Profile](help/API-Entities#Profile) data of the authenticated user.
 776
 777 #### Return values
 778
 779 On success: Array of:
 780
 781 * `global_dir`: URL of the global directory set in server settings
 782 * `friendica_owner`: user data of the authenticated user
 783 * `profiles`: array of the profile data
 784
 785 On error:
 786 HTTP 403 Forbidden: when no authentication was provided
 787 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
 788
 789 General description of profile data in API returns:
 790 - hide_friends: true if friends are hidden
 791 - profile_photo
 792 - profile_thumb
 793 - publish: true if published on the server's local directory
 794 - net_publish: true if published to global_dir
 795 - fullname
 796 - date_of_birth
 797 - description
 798 - xmpp
 799 - homepage
 800 - address
 801 - locality
 802 - region
 803 - postal_code
 804 - country
 805 - pub_keywords
 806 - custom_fields: list of public custom fields
 807
 808 ---
 809
 810 ### POST api/friendica/statuses/:id/dislike
 811
 812 Marks the given status as disliked by this user
 813
 814 #### Path Parameter
 815
 816 * `id`: the status ID that is being marked
 817
 818 #### Return values
 819
 820 A Mastodon [Status Entity](https://docs.joinmastodon.org/entities/Status/)
 821
 822 #### Example:
 823 `https://<server_name>/api/friendica/statuses/341/dislike`
 824
 825 ```json
 826 {
 827   "id": "341",
 828   "created_at": "2023-02-23T01:50:00.000Z",
 829   "in_reply_to_id": null,
 830   "in_reply_to_status": null,
 831   "in_reply_to_account_id": null,
 832   "sensitive": false,
 833   "spoiler_text": "",
 834   "visibility": "public",
 835   "language": "en",
 836   ...
 837   "account": {
 838     "id": "8",
 839     "username": "testuser2",
 840     ...
 841   },
 842   "media_attachments": [],
 843   "mentions": [],
 844   "tags": [],
 845   "emojis": [],
 846   "card": null,
 847   "poll": null,
 848   "friendica": {
 849     "title": "",
 850     "dislikes_count": 1,
 851     "disliked": true
 852   }
 853 }
 854 ```
 855
 856
 857 ### GET api/friendica/statuses/:id/disliked_by
 858
 859 Returns the list of accounts that have disliked the status as known by the current server
 860
 861 #### Path Parameter
 862
 863 * `id`: the status ID that is being marked
 864
 865 #### Return values
 866
 867 A list of [Mastodon Account](https://docs.joinmastodon.org/entities/Account/) objects
 868 in the body and next/previous link headers in the header
 869
 870 #### Example:
 871 `https://<server_name>/api/friendica/statuses/341/disliked_by`
 872
 873 ```json
 874 [
 875   {
 876     "id": "6",
 877     "username": "testuser1",
 878     ...
 879   }
 880 ]
 881 ```
 882
 883
 884
 885 ### POST api/friendica/statuses/:id/undislike
 886
 887 Removes the dislike mark (if it exists) on this status for this user
 888
 889 #### Path Parameter
 890
 891 * `id`: the status ID that is being marked
 892
 893 #### Return values
 894
 895 A Mastodon [Status Entity](https://docs.joinmastodon.org/entities/Status/)
 896
 897 #### Example:
 898 `https://<server_name>/api/friendica/statuses/341/undislike`
 899
 900 ```json
 901 {
 902   "id": "341",
 903   "created_at": "2023-02-23T01:50:00.000Z",
 904   "in_reply_to_id": null,
 905   "in_reply_to_status": null,
 906   "in_reply_to_account_id": null,
 907   "sensitive": false,
 908   "spoiler_text": "",
 909   "visibility": "public",
 910   "language": "en",
 911   ...
 912   "account": {
 913     "id": "8",
 914     "username": "testuser2",
 915     ...
 916   },
 917   "media_attachments": [],
 918   "mentions": [],
 919   "tags": [],
 920   "emojis": [],
 921   "card": null,
 922   "poll": null,
 923   "friendica": {
 924     "title": "",
 925     "dislikes_count": 0,
 926     "disliked": false
 927   }
 928 }
 929 ```
 930
 931 ---
 932
 933 ## Deprecated endpoints
 934
 935 - POST api/statuses/mediap