doc/API-Entities.md

   1 # Friendica API entities
   2
   3 * [Home](help)
   4   * [Using the APIs](help/api)
   5
   6
   7 ## Activities
   8
   9 <table class="table table-condensed table-striped table-bordered">
  10 <thead>
  11 <tr>
  12 <th>Attribute</th>
  13 <th>Type</th>
  14 <th align="center">Nullable</th>
  15 </tr>
  16 </thead>
  17 <tbody>
  18
  19 <tr>
  20 <td><code>like</code></td>
  21 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
  22 <td align="center">No</td>
  23 </tr>
  24
  25 <tr>
  26 <td><code>dislike</code></td>
  27 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
  28 <td align="center">No</td>
  29 </tr>
  30
  31 <tr>
  32 <td><code>attendyes</code></td>
  33 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
  34 <td align="center">No</td>
  35 </tr>
  36
  37 <tr>
  38 <td><code>attendno</code></td>
  39 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
  40 <td align="center">No</td>
  41 </tr>
  42
  43 <tr>
  44 <td><code>attendmaybe</code></td>
  45 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
  46 <td align="center">No</td>
  47 </tr>
  48
  49 </tbody>
  50 </table>
  51
  52 ## Attachment
  53
  54 <table class="table table-condensed table-striped table-bordered">
  55 <thead>
  56 <tr>
  57 <th>Attribute</th>
  58 <th>Type</th>
  59 <th align="center">Nullable</th>
  60 </tr>
  61 </thead>
  62 <tbody>
  63
  64 <tr>
  65 <td><code>url</code></td>
  66 <td>String (URL)</td>
  67 <td align="center">No</td>
  68 </tr>
  69
  70 <tr>
  71 <td><code>mimetype</code></td>
  72 <td>String</td>
  73 <td align="center">No</td>
  74 </tr>
  75
  76 <tr>
  77 <td><code>size</code></td>
  78 <td>Integer (bytes)</td>
  79 <td align="center">No</td>
  80 </tr>
  81
  82 </tbody>
  83 </table>
  84
  85 ## Contact
  86
  87 <table class="table table-condensed table-striped table-bordered">
  88 <thead>
  89 <tr>
  90 <th>Attribute</th>
  91 <th>Type</th>
  92 <th align="center">Nullable</th>
  93 </tr>
  94 </thead>
  95
  96 <tbody>
  97 <tr>
  98 <td><code>id</code></td>
  99 <td>Integer</td>
 100 <td align="center">No</td>
 101 </tr>
 102
 103 <tr>
 104 <td><code>id_str</code></td>
 105 <td>String</td>
 106 <td align="center">No</td>
 107 </tr>
 108
 109 <tr>
 110 <td><code>name</code></td>
 111 <td>String</td>
 112 <td align="center">No</td>
 113 </tr>
 114
 115 <tr>
 116 <td><code>screen_name</code></td>
 117 <td>String</td>
 118 <td align="center">No</td>
 119 </tr>
 120
 121 <tr>
 122 <td><code>location</code></td>
 123 <td>String</td>
 124 <td align="center">No</td>
 125 </tr>
 126
 127 <tr>
 128 <td><code>description</code></td>
 129 <td>String</td>
 130 <td align="center">No</td>
 131 </tr>
 132
 133 <tr>
 134 <td><code>profile_image_url</code></td>
 135 <td>String (URL)</td>
 136 <td align="center">No</td>
 137 </tr>
 138
 139 <tr>
 140 <td><code>profile_image_url_https</code></td>
 141 <td>String (URL)</td>
 142 <td align="center">No</td>
 143 </tr>
 144
 145 <tr>
 146 <td><code>profile_image_url_profile_size</code></td>
 147 <td>String (URL)</td>
 148 <td align="center">No</td>
 149 </tr>
 150
 151 <tr>
 152 <td><code>profile_image_url_large</code></td>
 153 <td>String (URL)</td>
 154 <td align="center">No</td>
 155 </tr>
 156
 157 <tr>
 158 <td><code>url</code></td>
 159 <td>String (URL)</td>
 160 <td align="center">No</td>
 161 </tr>
 162
 163 <tr>
 164 <td><code>protected</code></td>
 165 <td>Boolean</td>
 166 <td align="center">No</td>
 167 </tr>
 168
 169 <tr>
 170 <td><code>followers_count</code></td>
 171 <td>Integer</td>
 172 <td align="center">No</td>
 173 </tr>
 174
 175 <tr>
 176 <td><code>friends_count</code></td>
 177 <td>Integer</td>
 178 <td align="center">No</td>
 179 </tr>
 180
 181 <tr>
 182 <td><code>listed_count</code></td>
 183 <td>Integer</td>
 184 <td align="center">No</td>
 185 </tr>
 186
 187 <tr>
 188 <td><code>favourites_count</code></td>
 189 <td>Integer</td>
 190 <td align="center">No</td>
 191 </tr>
 192
 193 <tr>
 194 <td><code>statuses_count</code></td>
 195 <td>Integer</td>
 196 <td align="center">No</td>
 197 </tr>
 198
 199 <tr>
 200 <td><code>created_at</code></td>
 201 <td>String (Date)<br/>
 202 Ex: Wed May 23 06:01:13 +0000 2007
 203 </td>
 204 <td align="center">No</td>
 205 </tr>
 206
 207 <tr>
 208 <td><code>utc_offset</code></td>
 209 <td>Integer</td>
 210 <td align="center">No</td>
 211 </tr>
 212
 213 <tr>
 214 <td><code>time_zone</code></td>
 215 <td>String</td>
 216 <td align="center">No</td>
 217 </tr>
 218
 219 <tr>
 220 <td><code>geo_enabled</code></td>
 221 <td>Boolean</td>
 222 <td align="center">No</td>
 223 </tr>
 224
 225 <tr>
 226 <td><code>verified</code></td>
 227 <td>Boolean</td>
 228 <td align="center">No</td>
 229 </tr>
 230
 231 <tr>
 232 <td><code>lang</code></td>
 233 <td>String</td>
 234 <td align="center">No</td>
 235 </tr>
 236
 237 <tr>
 238 <td><code>contributors_enabled</code></td>
 239 <td>Boolean</td>
 240 <td align="center">No</td>
 241 </tr>
 242
 243 <tr>
 244 <td><code>is_translator</code></td>
 245 <td>Boolean</td>
 246 <td align="center">No</td>
 247 </tr>
 248
 249 <tr>
 250 <td><code>is_translation_enabled</code></td>
 251 <td>Boolean</td>
 252 <td align="center">No</td>
 253 </tr>
 254
 255 <tr>
 256 <td><code>following</code></td>
 257 <td>Boolean</td>
 258 <td align="center">No</td>
 259 </tr>
 260
 261 <tr>
 262 <td><code>follow_request_sent</code></td>
 263 <td>Boolean</td>
 264 <td align="center">No</td>
 265 </tr>
 266
 267 <tr>
 268 <td><code>statusnet_blocking</code></td>
 269 <td>Boolean</td>
 270 <td align="center">No</td>
 271 </tr>
 272
 273 <tr>
 274 <td><code>notifications</code></td>
 275 <td>Boolean</td>
 276 <td align="center">No</td>
 277 </tr>
 278
 279 <tr>
 280 <td><code>statusnet_profile_url</code></td>
 281 <td>String (URL)</td>
 282 <td align="center">No</td>
 283 </tr>
 284
 285 <tr>
 286 <td><code>uid</code></td>
 287 <td>Integer</td>
 288 <td align="center">No</td>
 289 </tr>
 290
 291 <tr>
 292 <td><code>cid</code></td>
 293 <td>Integer</td>
 294 <td align="center">No</td>
 295 </tr>
 296
 297 <tr>
 298 <td><code>pid</code></td>
 299 <td>Integer</td>
 300 <td align="center">No</td>
 301 </tr>
 302
 303 <tr>
 304 <td><code>self</code></td>
 305 <td>Integer</td>
 306 <td align="center">No</td>
 307 </tr>
 308
 309 <tr>
 310 <td><code>network</code></td>
 311 <td>String</td>
 312 <td align="center">No</td>
 313 </tr>
 314
 315 </tbody>
 316 </table>
 317
 318
 319 ## Entities
 320
 321 <table class="table table-condensed table-striped table-bordered">
 322 <thead>
 323 <tr>
 324 <th>Attribute</th>
 325 <th>Type</th>
 326 <th align="center">Nullable</th>
 327 </tr>
 328 </thead>
 329 <tbody>
 330
 331 <tr>
 332 <td><code>hashtags</code></td>
 333 <td>List of <a href="help/API-Entities#Hashtag">Hashtags</a></td>
 334 <td align="center">No</td>
 335 </tr>
 336
 337 <tr>
 338 <td><code>symbols</code></td>
 339 <td>List of <a href="help/API-Entities#Symbol">Symbols</a></td>
 340 <td align="center">No</td>
 341 </tr>
 342
 343 <tr>
 344 <td><code>urls</code></td>
 345 <td>List of <a href="help/API-Entities#URL">URLs</a></td>
 346 <td align="center">No</td>
 347 </tr>
 348
 349 <tr>
 350 <td><code>user_mentions</code></td>
 351 <td>List of <a href="help/API-Entities#User+Mention">User mentions</a></td>
 352 <td align="center">No</td>
 353 </tr>
 354
 355 <tr>
 356 <td><code>media</code></td>
 357 <td>List of <a href="help/API-Entities#Media">Medias</a></td>
 358 <td align="center">No</td>
 359 </tr>
 360
 361 </tbody>
 362 </table>
 363
 364 ## Hashtag
 365
 366 Unused
 367
 368 ## Item
 369
 370 <table class="table table-condensed table-striped table-bordered">
 371 <thead>
 372 <tr>
 373 <th>Attribute</th>
 374 <th>Type</th>
 375 <th align="center">Nullable</th>
 376 </tr>
 377 </thead>
 378
 379 <tbody>
 380 <tr>
 381 <td><code>text</code></td>
 382 <td>String (Plaintext)</td>
 383 <td align="center">No</td>
 384 </tr>
 385
 386 <tr>
 387 <td><code>truncated</code></td>
 388 <td>Boolean</td>
 389 <td align="center">No</td>
 390 </tr>
 391
 392 <tr>
 393 <td><code>created_at</code></td>
 394 <td>String (Date)<br/>
 395 Ex: Wed May 23 06:01:13 +0000 2007
 396 </td>
 397 <td align="center">No</td>
 398 </tr>
 399
 400 <tr>
 401 <td><code>in_reply_to_status_id</code></td>
 402 <td>Integer</td>
 403 <td align="center">No</td>
 404 </tr>
 405
 406 <tr>
 407 <td><code>in_reply_to_status_id_str</code></td>
 408 <td>String</td>
 409 <td align="center">No</td>
 410 </tr>
 411
 412 <tr>
 413 <td><code>source</code></td>
 414 <td>String</td>
 415 <td align="center">No</td>
 416 </tr>
 417
 418 <tr>
 419 <td><code>id</code></td>
 420 <td>Integer</td>
 421 <td align="center">No</td>
 422 </tr>
 423
 424 <tr>
 425 <td><code>id_str</code></td>
 426 <td>String</td>
 427 <td align="center">No</td>
 428 </tr>
 429
 430 <tr>
 431 <td><code>in_reply_to_user_id</code></td>
 432 <td>Integer</td>
 433 <td align="center">No</td>
 434 </tr>
 435
 436 <tr>
 437 <td><code>in_reply_to_user_id_str</code></td>
 438 <td>String</td>
 439 <td align="center">No</td>
 440 </tr>
 441
 442 <tr>
 443 <td><code>in_reply_to_screen_name</code></td>
 444 <td>String</td>
 445 <td align="center">No</td>
 446 </tr>
 447
 448 <tr>
 449 <td><code>geo</code></td>
 450 <td>String</td>
 451 <td align="center">Yes</td>
 452 </tr>
 453
 454 <tr>
 455 <td><code>favorited</code></td>
 456 <td>Boolean</td>
 457 <td align="center">No</td>
 458 </tr>
 459
 460 <tr>
 461 <td><code>user</code></td>
 462 <td><a href="help/API-Entities#Contact">Contact</a></td>
 463 <td align="center">No</td>
 464 </tr>
 465
 466 <tr>
 467 <td><code>friendica_author</code></td>
 468 <td><a href="help/API-Entities#Contact">Contact</a></td>
 469 <td align="center">No</td>
 470 </tr>
 471
 472 <tr>
 473 <td><code>friendica_owner</code></td>
 474 <td>
 475
 476 <a href="help/API-Entities#Contact">Contact</a></td>
 477 <td align="center">No</td>
 478 </tr>
 479
 480 <tr>
 481 <td><code>friendica_private</code></td>
 482 <td>Boolean</td>
 483 <td align="center">No</td>
 484 </tr>
 485
 486 <tr>
 487 <td><code>statusnet_html</code></td>
 488 <td>String (HTML)</td>
 489 <td align="center">No</td>
 490 </tr>
 491
 492 <tr>
 493 <td><code>statusnet_conversation_id</code></td>
 494 <td>Integer</td>
 495 <td align="center">No</td>
 496 </tr>
 497
 498 <tr>
 499 <td><code>external_url</code></td>
 500 <td>String (URL)</td>
 501 <td align="center">No</td>
 502 </tr>
 503
 504 <tr>
 505 <td><code>friendica_activities</code></td>
 506 <td><a href="help/API-Entities#Activities">Activities</a></td>
 507 <td align="center">No</td>
 508 </tr>
 509
 510 <tr>
 511 <td><code>friendica_title</code></td>
 512 <td>String (Plaintext)</td>
 513 <td align="center">No</td>
 514 </tr>
 515
 516 <tr>
 517 <td><code>friendica_html</code></td>
 518 <td>String (HTML)</td>
 519 <td align="center">No</td>
 520 </tr>
 521
 522 <tr>
 523 <td><code>attachments</code></td>
 524 <td>List of <a href="help/API-Entities#Attachment">Attachments</a></td>
 525 <td align="center">Yes</td>
 526 </tr>
 527
 528 <tr>
 529 <td><code>entities</code></td>
 530 <td><a href="help/API-Entities#Entities">Entities</a></td>
 531 <td align="center">Yes</td>
 532 </tr>
 533
 534 </tbody>
 535 </table>
 536
 537 ## Media
 538
 539 Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/entities-object#media).
 540
 541 <table class="table table-condensed table-striped table-bordered">
 542 <thead>
 543 <tr>
 544 <th>Attribute</th>
 545 <th>Type</th>
 546 <th align="center">Nullable</th>
 547 </tr>
 548 </thead>
 549 <tbody>
 550
 551 <tr>
 552 <td><code>id</code></td>
 553 <td>Integer</td>
 554 <td align="center">No</td>
 555 </tr>
 556
 557 <tr>
 558 <td><code>id_str</code></td>
 559 <td>String</td>
 560 <td align="center">No</td>
 561 </tr>
 562
 563 <tr>
 564 <td><code>indices</code></td>
 565 <td>List of Integer</td>
 566 <td align="center">No</td>
 567 </tr>
 568
 569 <tr>
 570 <td><code>media_url</code></td>
 571 <td>String (URL)</td>
 572 <td align="center">No</td>
 573 </tr>
 574
 575 <tr>
 576 <td><code>media_url_https</code></td>
 577 <td>String (URL)</td>
 578 <td align="center">No</td>
 579 </tr>
 580
 581 <tr>
 582 <td><code>url</code></td>
 583 <td>String (URL)</td>
 584 <td align="center">No</td>
 585 </tr>
 586
 587 <tr>
 588 <td><code>display_url</code></td>
 589 <td>String (URL)</td>
 590 <td align="center">No</td>
 591 </tr>
 592
 593 <tr>
 594 <td><code>expanded_url</code></td>
 595 <td>String (URL)</td>
 596 <td align="center">No</td>
 597 </tr>
 598
 599 <tr>
 600 <td><code>ext_alt_text</code></td>
 601 <td>String</td>
 602 <td align="center">No</td>
 603 </tr>
 604
 605 <tr>
 606 <td><code>type</code></td>
 607 <td>String</td>
 608 <td align="center">No</td>
 609 </tr>
 610
 611 <tr>
 612 <td><code>sizes</code></td>
 613 <td><a href="help/API-Entities#Sizes">Sizes</a></td>
 614 <td align="center">No</td>
 615 </tr>
 616
 617 </tbody>
 618 </table>
 619
 620 ## Notification
 621
 622 <table class="table table-condensed table-striped table-bordered">
 623 <thead>
 624 <tr>
 625 <th>Attribute</th>
 626 <th>Type</th>
 627 <th>Description</th>
 628 </tr>
 629 </thead>
 630 <tbody>
 631
 632 <tr>
 633 <td><code>id</code></td>
 634 <td>Integer</td>
 635 <td></td>
 636 </tr>
 637
 638 <tr>
 639 <td><code>hash</code></td>
 640 <td>String</td>
 641 <td></td>
 642 </tr>
 643
 644 <tr>
 645 <td><code>type</code></td>
 646 <td>Integer</td>
 647 <td><ul>
 648 <li>1: Inbound follow request</li>
 649 <li>2: Outbound follow request confirmation</li>
 650 <li>4: Wall-to-wall post</li>
 651 <li>8: Reply</li>
 652 <li>16: Private message</li>
 653 <li>32: Friend suggestion</li>
 654 <li>64: Unused</li>
 655 <li>128: Mention</li>
 656 <li>256: Tag added to a post</li>
 657 <li>512: Poke</li>
 658 <li>1024: New post</li>
 659 <li>16384: System email</li>
 660 <li>32768: System event</li>
 661 </ul></td>
 662 </tr>
 663
 664 <tr>
 665 <td><code>name</code></td>
 666 <td>String</td>
 667 <td>Full name of the contact subject</td>
 668 </tr>
 669
 670 <tr>
 671 <td><code>url</code></td>
 672 <td>String (URL)</td>
 673 <td>Profile page URL of the contact subject</td>
 674 </tr>
 675
 676 <tr>
 677 <td><code>photo</code></td>
 678 <td>String (URL)</td>
 679 <td>Profile photo URL of the contact subject</td>
 680 </tr>
 681
 682 <tr>
 683 <td><code>date</code></td>
 684 <td>String (Date)</td>
 685 <td><code>YYYY-MM-DD hh:mm:ss</code> local server time</td>
 686 </tr>
 687
 688 <tr>
 689 <td><code>msg</code></td>
 690 <td>String (BBCode)</td>
 691 <td></td>
 692 </tr>
 693
 694 <tr>
 695 <td><code>uid</code></td>
 696 <td>Integer</td>
 697 <td>Owner User Id</td>
 698 </tr>
 699
 700 <tr>
 701 <td><code>link</code></td>
 702 <td>String (URL)</td>
 703 <td>Notification URL</td>
 704 </tr>
 705
 706 <tr>
 707 <td><code>iid</code></td>
 708 <td>Integer</td>
 709 <td>Item Id</td>
 710 </tr>
 711
 712 <tr>
 713 <td><code>parent</code></td>
 714 <td>Integer</td>
 715 <td>Parent Item Id</td>
 716 </tr>
 717
 718 <tr>
 719 <td><code>seen</code></td>
 720 <td>Integer (Boolean)</td>
 721 <td>Whether the notification was read or not.</td>
 722 </tr>
 723
 724 <tr>
 725 <td><code>verb</code></td>
 726 <td>String (URL)</td>
 727 <td>[Activity Streams](http://activitystrea.ms) Verb URL</td>
 728 </tr>
 729
 730 <tr>
 731 <td><code>seen</code></td>
 732 <td>Integer (Boolean)</td>
 733 <td>Whether the notification was read or not.</td>
 734 </tr>
 735
 736 <tr>
 737 <td><code>otype</code></td>
 738 <td>Enum</td>
 739 <td>Subject type (`item`, `intro` or `mail`)</td>
 740 </tr>
 741
 742 <tr>
 743 <td><code>name_cache</code></td>
 744 <td>String (HTML)</td>
 745 <td>Full name of the contact subject</td>
 746 </tr>
 747
 748 <tr>
 749 <td><code>msg_cache</code></td>
 750 <td>String (Plaintext)</td>
 751 <td>Plaintext version of the notification text with a placeholder (`{0}`) for the subject contact's name.</td>
 752 </tr>
 753
 754 <tr>
 755 <td><code>timestamp</code></td>
 756 <td>Integer</td>
 757 <td>Unix timestamp</td>
 758 </tr>
 759
 760 <tr>
 761 <td><code>date_rel</code></td>
 762 <td>String</td>
 763 <td>Time since the note was posted, eg "1 hour ago"</td>
 764 </tr>
 765
 766
 767 <tr>
 768 <td><code>msg_html</code></td>
 769 <td>String (HTML)</td>
 770 <td></td>
 771 </tr>
 772
 773 <tr>
 774 <td><code>msg_plain</code></td>
 775 <td>String (Plaintext)</td>
 776 <td></td>
 777 </tr>
 778
 779 </tbody>
 780 </table>
 781
 782 ## Photo
 783
 784 <table class="table table-condensed table-striped table-bordered">
 785 <thead>
 786 <tr>
 787 <th>Attribute</th>
 788 <th>Type</th>
 789 <th>Description</th>
 790 </tr>
 791 </thead>
 792 <tbody>
 793
 794 <tr>
 795 <td><code>id</code></td>
 796 <td>String</td>
 797 <td>Resource ID (32 hex chars)</td>
 798 </tr>
 799
 800 <tr>
 801 <td><code>created</code></td>
 802 <td>String (Date)</td>
 803 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
 804 </tr>
 805
 806 <tr>
 807 <td><code>edited</code></td>
 808 <td>String (Date)</td>
 809 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
 810 </tr>
 811
 812 <tr>
 813 <td><code>title</code></td>
 814 <td>String</td>
 815 <td></td>
 816 </tr>
 817
 818 <tr>
 819 <td><code>desc</code></td>
 820 <td>String (Plaintext)</td>
 821 <td>Picture caption</td>
 822 </tr>
 823
 824 <tr>
 825 <td><code>album</code></td>
 826 <td>String</td>
 827 <td>Album name</td>
 828 </tr>
 829
 830 <tr>
 831 <td><code>filename</code></td>
 832 <td>String</td>
 833 <td>Original image filename</td>
 834 </tr>
 835
 836 <tr>
 837 <td><code>type</code></td>
 838 <td>String</td>
 839 <td>MIME Type</td>
 840 </tr>
 841
 842 <tr>
 843 <td><code>height</code></td>
 844 <td>Integer</td>
 845 <td>Image height in pixels</td>
 846 </tr>
 847
 848 <tr>
 849 <td><code>width</code></td>
 850 <td>Integer</td>
 851 <td>Image width in pixels</td>
 852 </tr>
 853
 854 <tr>
 855 <td><code>profile</code></td>
 856 <td>Integer</td>
 857 <td>1 if it is a profile photo</td>
 858 </tr>
 859
 860 <tr>
 861 <td><code>allow_cid</code></td>
 862 <td>String (ACL)</td>
 863 <td>List of contact ids wrapped in angle brackets allowed to access the photo.</td>
 864 </tr>
 865
 866 <tr>
 867 <td><code>allow_gid</code></td>
 868 <td>String (ACL)</td>
 869 <td>List of contact group ids wrapped in angle brackets allowed to access the photo.</td>
 870 </tr>
 871
 872 <tr>
 873 <td><code>deny_cid</code></td>
 874 <td>String (ACL)</td>
 875 <td>List of contact ids wrapped in angle brackets forbidden to access the photo.</td>
 876 </tr>
 877
 878 <tr>
 879 <td><code>deny_gid</code></td>
 880 <td>String (ACL)</td>
 881 <td>List of contact group ids wrapped in angle brackets forbidden to access the photo.</td>
 882 </tr>
 883
 884 <tr>
 885 <td><code>link</code></td>
 886 <td>Array of Strings (URL)</td>
 887 <td>
 888 URLs to the different scales indexed by scale number if no specific scale was requested.
 889 Mutually exclusive with <code>data</code> <code>datasize</code>.
 890 </td>
 891 </tr>
 892
 893 <tr>
 894 <td><code>datasize</code></td>
 895 <td>Integer</td>
 896 <td>
 897 Picture size in bytes if a single scale was requested.
 898 Mutually exclusive with <code>link</code>.
 899 </td>
 900 </tr>
 901
 902 <tr>
 903 <td><code>data</code></td>
 904 <td>String</td>
 905 <td>
 906 Base64-encoded image data if a single scale was requested.
 907 Mutually exclusive with <code>link</code>.
 908 </td>
 909 </tr>
 910
 911 <tr>
 912 <td><code>friendica_activities</code></td>
 913 <td><a href="help/API-Entities#Activities">Activities</a></td>
 914 <td></td>
 915 </tr>
 916
 917 <tr>
 918 <td><code>friendica_comments</code></td>
 919 <td>List of <a href="help/API-Entities#Item">Items</a></td>
 920 <td></td>
 921 </tr>
 922
 923 <tr>
 924 <td><code>rights_mismatch</code></td>
 925 <td>Boolean</td>
 926 <td>True if the ACL differs between the picture and the associated item.</td>
 927 </tr>
 928
 929 </tbody>
 930 </table>
 931
 932 ## Photo List Item
 933
 934 <table class="table table-condensed table-striped table-bordered">
 935 <thead>
 936 <tr>
 937 <th>Attribute</th>
 938 <th>Type</th>
 939 <th>Description</th>
 940 </tr>
 941 </thead>
 942 <tbody>
 943
 944 <tr>
 945 <td><code>id</code></td>
 946 <td>String</td>
 947 <td>Resource ID (32 hex chars)</td>
 948 </tr>
 949
 950 <tr>
 951 <td><code>album</code></td>
 952 <td>String</td>
 953 <td>Album name</td>
 954 </tr>
 955
 956 <tr>
 957 <td><code>filename</code></td>
 958 <td>String</td>
 959 <td>Original image filename</td>
 960 </tr>
 961
 962 <tr>
 963 <td><code>type</code></td>
 964 <td>String</td>
 965 <td>MIME Type</td>
 966 </tr>
 967
 968 <tr>
 969 <td><code>created</code></td>
 970 <td>String (Date)</td>
 971 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
 972 </tr>
 973
 974 <tr>
 975 <td><code>edited</code></td>
 976 <td>String (Date)</td>
 977 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
 978 </tr>
 979
 980 <tr>
 981 <td><code>desc</code></td>
 982 <td>String (Plaintext)</td>
 983 <td>Picture caption</td>
 984 </tr>
 985
 986 <tr>
 987 <td><code>thumb</code></td>
 988 <td>String (URL)</td>
 989 <td>URL of the smallest scale version of the picture.</td>
 990 </tr>
 991
 992 </tbody>
 993 </table>
 994
 995 ## Private message
 996
 997 <table class="table table-condensed table-striped table-bordered">
 998 <thead>
 999 <tr>
1000 <th>Attribute</th>
1001 <th>Type</th>
1002 <th>Description</th>
1003 </tr>
1004 </thead>
1005 <tbody>
1006
1007 <tr>
1008 <td><code>id</code></td>
1009 <td>Integer</td>
1010 <td></td>
1011 </tr>
1012
1013 <tr>
1014 <td><code>sender_id</code></td>
1015 <td>Integer</td>
1016 <td>Sender Contact Id</td>
1017 </tr>
1018
1019 <tr>
1020 <td><code>text</code></td>
1021 <td>String</td>
1022 <td>Can be HTML or plaintext depending on the API call parameter `getText`.</td>
1023 </tr>
1024
1025 <tr>
1026 <td><code>recipient_id</code></td>
1027 <td>Integer</td>
1028 <td>Recipient Contact Id</td>
1029 </tr>
1030
1031 <tr>
1032 <td><code>created_at</code></td>
1033 <td>String (Date)</td>
1034 <td>Ex: Wed May 23 06:01:13 +0000 2007</td>
1035 </tr>
1036
1037 <tr>
1038 <td><code>sender_screen_name</code></td>
1039 <td>String</td>
1040 <td></td>
1041 </tr>
1042
1043 <tr>
1044 <td><code>recipient_screen_name</code></td>
1045 <td>String</td>
1046 <td></td>
1047 </tr>
1048
1049 <tr>
1050 <td><code>sender</code></td>
1051 <td><a href="help/API-Entities#Contact">Contact</a></td>
1052 <td></td>
1053 </tr>
1054
1055 <tr>
1056 <td><code>recipient</code></td>
1057 <td><a href="help/API-Entities#Contact">Contact</a></td>
1058 <td></td>
1059 </tr>
1060
1061 <tr>
1062 <td><code>title</code></td>
1063 <td>String</td>
1064 <td>Empty if the API call parameter `getText` is empty or absent.</td>
1065 </tr>
1066
1067 <tr>
1068 <td><code>friendica_seen</code></td>
1069 <td>Integer (Boolean)</td>
1070 <td>Whether the private message has been read or not.</td>
1071 </tr>
1072
1073 <tr>
1074 <td><code>friendica_parent_uri</code></td>
1075 <td>String</td>
1076 <td></td>
1077 </tr>
1078
1079 </tbody>
1080 </table>
1081
1082 ## Profile
1083
1084 <table class="table table-condensed table-striped table-bordered">
1085 <thead>
1086 <tr>
1087 <th>Attribute</th>
1088 <th>Type</th>
1089 <th>Description</th>
1090 </tr>
1091 </thead>
1092 <tbody>
1093
1094 <tr>
1095 <td><code>profile_id</code></td>
1096 <td>Integer</td>
1097 <td></td>
1098 </tr>
1099
1100 <tr>
1101 <td><code>profile_name</code></td>
1102 <td>String</td>
1103 <td></td>
1104 </tr>
1105
1106 <tr>
1107 <td><code>is_default</code></td>
1108 <td>Boolean</td>
1109 <td></td>
1110 </tr>
1111
1112 <tr>
1113 <td><code>hide_friends</code></td>
1114 <td>Boolean</td>
1115 <td>Whether the user chose to hide their contact list on their profile.</td>
1116 </tr>
1117
1118 <tr>
1119 <td><code>profile_photo</code></td>
1120 <td>String (URL)</td>
1121 <td>Largest size profile picture URL.</td>
1122 </tr>
1123
1124 <tr>
1125 <td><code>profile_thumb</code></td>
1126 <td>String (URL)</td>
1127 <td>Smallest size profile picture URL.</td>
1128 </tr>
1129
1130 <tr>
1131 <td><code>publish</code></td>
1132 <td>Boolean</td>
1133 <td>Whether the user chose to publish their profile in the local directory.</td>
1134 </tr>
1135
1136 <tr>
1137 <td><code>net_publish</code></td>
1138 <td>Boolean</td>
1139 <td>Whether the user chose to publish their profile in the global directory.</td>
1140 </tr>
1141
1142 <tr>
1143 <td><code>description</code></td>
1144 <td>String</td>
1145 <td></td>
1146 </tr>
1147
1148 <tr>
1149 <td><code>date_of_birth</code></td>
1150 <td>String</td>
1151 <td></td>
1152 </tr>
1153
1154 <tr>
1155 <td><code>address</code></td>
1156 <td>String</td>
1157 <td></td>
1158 </tr>
1159
1160 <tr>
1161 <td><code>city</code></td>
1162 <td>String</td>
1163 <td></td>
1164 </tr>
1165
1166 <tr>
1167 <td><code>region</code></td>
1168 <td>String</td>
1169 <td></td>
1170 </tr>
1171
1172 <tr>
1173 <td><code>postal_code</code></td>
1174 <td>String</td>
1175 <td></td>
1176 </tr>
1177
1178 <tr>
1179 <td><code>country</code></td>
1180 <td>String</td>
1181 <td></td>
1182 </tr>
1183
1184 <tr>
1185 <td><code>hometown</code></td>
1186 <td>String</td>
1187 <td></td>
1188 </tr>
1189
1190 <tr>
1191 <td><code>gender</code></td>
1192 <td>String</td>
1193 <td></td>
1194 </tr>
1195
1196 <tr>
1197 <td><code>marital</code></td>
1198 <td>String</td>
1199 <td></td>
1200 </tr>
1201
1202 <tr>
1203 <td><code>marital_with</code></td>
1204 <td>String</td>
1205 <td></td>
1206 </tr>
1207
1208 <tr>
1209 <td><code>marital_since</code></td>
1210 <td>String (Date)</td>
1211 <td></td>
1212 </tr>
1213
1214 <tr>
1215 <td><code>sexual</code></td>
1216 <td>String</td>
1217 <td></td>
1218 </tr>
1219
1220 <tr>
1221 <td><code>politic</code></td>
1222 <td>String</td>
1223 <td></td>
1224 </tr>
1225
1226 <tr>
1227 <td><code>religion</code></td>
1228 <td>String</td>
1229 <td></td>
1230 </tr>
1231
1232 <tr>
1233 <td><code>public_keywords</code></td>
1234 <td>String</td>
1235 <td>Comma-separated list of words meant to be displayed as hashtags.</td>
1236 </tr>
1237
1238 <tr>
1239 <td><code>private_keywords</code></td>
1240 <td>String</td>
1241 <td>Comma-separated list of words meant to be used for search only.</td>
1242 </tr>
1243
1244 <tr>
1245 <td><code>likes</code></td>
1246 <td>String (Plaintext)</td>
1247 <td></td>
1248 </tr>
1249
1250 <tr>
1251 <td><code>dislikes</code></td>
1252 <td>String (Plaintext)</td>
1253 <td></td>
1254 </tr>
1255
1256 <tr>
1257 <td><code>about</code></td>
1258 <td>String (Plaintext)</td>
1259 <td></td>
1260 </tr>
1261
1262 <tr>
1263 <td><code>music</code></td>
1264 <td>String (Plaintext)</td>
1265 <td></td>
1266 </tr>
1267
1268 <tr>
1269 <td><code>book</code></td>
1270 <td>String (Plaintext)</td>
1271 <td></td>
1272 </tr>
1273
1274 <tr>
1275 <td><code>tv</code></td>
1276 <td>String (Plaintext)</td>
1277 <td></td>
1278 </tr>
1279
1280 <tr>
1281 <td><code>film</code></td>
1282 <td>String (Plaintext)</td>
1283 <td></td>
1284 </tr>
1285
1286 <tr>
1287 <td><code>interest</code></td>
1288 <td>String (Plaintext)</td>
1289 <td></td>
1290 </tr>
1291
1292 <tr>
1293 <td><code>romance</code></td>
1294 <td>String (Plaintext)</td>
1295 <td></td>
1296 </tr>
1297
1298 <tr>
1299 <td><code>work</code></td>
1300 <td>String (Plaintext)</td>
1301 <td></td>
1302 </tr>
1303
1304 <tr>
1305 <td><code>education</code></td>
1306 <td>String (Plaintext)</td>
1307 <td></td>
1308 </tr>
1309
1310 <tr>
1311 <td><code>social_networks</code></td>
1312 <td>String (Plaintext)</td>
1313 <td></td>
1314 </tr>
1315
1316 <tr>
1317 <td><code>homepage</code></td>
1318 <td>String (URL)</td>
1319 <td></td>
1320 </tr>
1321
1322 <tr>
1323 <td><code>users</code></td>
1324 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
1325 <td>If populated, only these contacts have access to the profile.</td>
1326 </tr>
1327
1328 </tbody>
1329 </table>
1330
1331 ## Size
1332
1333 <table class="table table-condensed table-striped table-bordered">
1334 <thead>
1335 <tr>
1336 <th>Attribute</th>
1337 <th>Type</th>
1338 <th align="center">Nullable</th>
1339 </tr>
1340 </thead>
1341 <tbody>
1342 <table class="table table-condensed table-striped table-bordered">
1343 <thead>
1344 <tr>
1345 <th>Attribute</th>
1346 <th>Type</th>
1347 <th align="center">Nullable</th>
1348 </tr>
1349 </thead>
1350 <tbody>
1351
1352 <tr>
1353 <td><code>w</code></td>
1354 <td>Integer</td>
1355 <td align="center">No</td>
1356 </tr>
1357
1358 <tr>
1359 <td><code>h</code></td>
1360 <td>Integer</td>
1361 <td align="center">No</td>
1362 </tr>
1363
1364 <tr>
1365 <td><code>resize</code></td>
1366 <td>Enum (fit, crop)</td>
1367 <td align="center">Yes</td>
1368 </tr>
1369
1370 </tbody>
1371 </table>
1372
1373
1374 ## Sizes
1375
1376 <table class="table table-condensed table-striped table-bordered">
1377 <thead>
1378 <tr>
1379 <th>Attribute</th>
1380 <th>Type</th>
1381 <th align="center">Nullable</th>
1382 </tr>
1383 </thead>
1384 <tbody>
1385
1386 <tr>
1387 <td><code>medium</code></td>
1388 <td><a href="help/API-Entities#Size">Size</a></td>
1389 <td align="center">No</td>
1390 </tr>
1391
1392 <tr>
1393 <td><code>large</code></td>
1394 <td><a href="help/API-Entities#Size">Size</a></td>
1395 <td align="center">Yes</td>
1396 </tr>
1397
1398 <tr>
1399 <td><code>thumb</code></td>
1400 <td><a href="help/API-Entities#Size">Size</a></td>
1401 <td align="center">Yes</td>
1402 </tr>
1403
1404 <tr>
1405 <td><code>small</code></td>
1406 <td><a href="help/API-Entities#Size">Size</a></td>
1407 <td align="center">Yes</td>
1408 </tr>
1409
1410 </tbody>
1411 </table>
1412
1413 ## Symbol
1414
1415 Unused
1416
1417 ## URL
1418
1419 <table class="table table-condensed table-striped table-bordered">
1420 <thead>
1421 <tr>
1422 <th>Attribute</th>
1423 <th>Type</th>
1424 <th align="center">Nullable</th>
1425 </tr>
1426 </thead>
1427 <tbody>
1428
1429 <tr>
1430 <td><code>url</code></td>
1431 <td>String (URL)</td>
1432 <td align="center">No</td>
1433 </tr>
1434
1435 <tr>
1436 <td><code>expanded_url</code></td>
1437 <td>String (URL)</td>
1438 <td align="center">No</td>
1439 </tr>
1440
1441 <tr>
1442 <td><code>display_url</code></td>
1443 <td>String (URL)</td>
1444 <td align="center">No</td>
1445 </tr>
1446
1447 <tr>
1448 <td><code>indices</code></td>
1449 <td>List of Integer</td>
1450 <td align="center">No</td>
1451 </tr>
1452
1453 </tbody>
1454 </table>
1455
1456 ## User Mention
1457
1458 Unused