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 ## Event
 365
 366 <table class="table table-condensed table-striped table-bordered">
 367 <thead>
 368 <tr>
 369 <th>Attribute</th>
 370 <th>Type</th>
 371 <th>Description</th>
 372 </tr>
 373 </thead>
 374
 375 <tbody>
 376 <tr>
 377 <td><code>id</code></td>
 378 <td>Integer</td>
 379 <td></td>
 380 </tr>
 381
 382 <tr>
 383 <td><code>uid</code></td>
 384 <td>Integer</td>
 385 <td>Owner User Id</td>
 386 </tr>
 387
 388 <tr>
 389 <td><code>cid</code></td>
 390 <td>Integer</td>
 391 <td>Target Contact Id</td>
 392 </tr>
 393
 394 <tr>
 395 <td><code>uri</code></td>
 396 <td>String</td>
 397 <td>Item unique URI string</td>
 398 </tr>
 399
 400 <tr>
 401 <td><code>name</code></td>
 402 <td>String (Plaintext)</td>
 403 <td>Title</td>
 404 </tr>
 405
 406 <tr>
 407 <td><code>desc</code></td>
 408 <td>String (HTML)</td>
 409 <td>Description</td>
 410 </tr>
 411
 412 <tr>
 413 <td><code>start_time</code></td>
 414 <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
 415 <td></td>
 416 </tr>
 417
 418 <tr>
 419 <td><code>end_time</code></td>
 420 <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
 421 <td>Optional (null date is <code>0001-01-01 00:00:00</code></td>
 422 </tr>
 423
 424 <tr>
 425 <td><code>type</code></td>
 426 <td>String (<code>event</code> or <code>birthday</code>)</td>
 427 <td></td>
 428 </tr>
 429
 430 <tr>
 431 <td><code>nofinish</code></td>
 432 <td>Boolean</td>
 433 <td>Ongoing event</td>
 434 </tr>
 435
 436 <tr>
 437 <td><code>place</code></td>
 438 <td>String</td>
 439 <td>Optional. Location.</td>
 440 </tr>
 441
 442 <tr>
 443 <td><code>ignore</code></td>
 444 <td>Boolean</td>
 445 <td>???</td>
 446 </tr>
 447
 448 <tr>
 449 <td><code>allow_cid</code></td>
 450 <td>String (angle-brackets escaped integers)</td>
 451 <td>Optional. List of allowed contact ids</td>
 452 </tr>
 453
 454 <tr>
 455 <td><code>allow_gid</code></td>
 456 <td>String (angle-brackets escaped integers)</td>
 457 <td>Optional. List of allowed circle ids</td>
 458 </tr>
 459
 460 <tr>
 461 <td><code>deny_cid</code></td>
 462 <td>String (angle-brackets escaped integers)</td>
 463 <td>Optional. List of disallowed contact ids</td>
 464 </tr>
 465
 466 <tr>
 467 <td><code>deny_gid</code></td>
 468 <td>String (angle-brackets escaped integers)</td>
 469 <td>Optional. List of disallowed circle ids</td>
 470 </tr>
 471
 472 </tbody>
 473 </table>
 474
 475 ## Hashtag
 476
 477 Unused
 478
 479 ## Item
 480
 481 <table class="table table-condensed table-striped table-bordered">
 482 <thead>
 483 <tr>
 484 <th>Attribute</th>
 485 <th>Type</th>
 486 <th align="center">Nullable</th>
 487 </tr>
 488 </thead>
 489
 490 <tbody>
 491 <tr>
 492 <td><code>text</code></td>
 493 <td>String (Plaintext)</td>
 494 <td align="center">No</td>
 495 </tr>
 496
 497 <tr>
 498 <td><code>truncated</code></td>
 499 <td>Boolean</td>
 500 <td align="center">No</td>
 501 </tr>
 502
 503 <tr>
 504 <td><code>created_at</code></td>
 505 <td>String (Date)<br/>
 506 Ex: Wed May 23 06:01:13 +0000 2007
 507 </td>
 508 <td align="center">No</td>
 509 </tr>
 510
 511 <tr>
 512 <td><code>in_reply_to_status_id</code></td>
 513 <td>Integer</td>
 514 <td align="center">No</td>
 515 </tr>
 516
 517 <tr>
 518 <td><code>in_reply_to_status_id_str</code></td>
 519 <td>String</td>
 520 <td align="center">No</td>
 521 </tr>
 522
 523 <tr>
 524 <td><code>source</code></td>
 525 <td>String</td>
 526 <td align="center">No</td>
 527 </tr>
 528
 529 <tr>
 530 <td><code>id</code></td>
 531 <td>Integer</td>
 532 <td align="center">No</td>
 533 </tr>
 534
 535 <tr>
 536 <td><code>id_str</code></td>
 537 <td>String</td>
 538 <td align="center">No</td>
 539 </tr>
 540
 541 <tr>
 542 <td><code>in_reply_to_user_id</code></td>
 543 <td>Integer</td>
 544 <td align="center">No</td>
 545 </tr>
 546
 547 <tr>
 548 <td><code>in_reply_to_user_id_str</code></td>
 549 <td>String</td>
 550 <td align="center">No</td>
 551 </tr>
 552
 553 <tr>
 554 <td><code>in_reply_to_screen_name</code></td>
 555 <td>String</td>
 556 <td align="center">No</td>
 557 </tr>
 558
 559 <tr>
 560 <td><code>geo</code></td>
 561 <td>String</td>
 562 <td align="center">Yes</td>
 563 </tr>
 564
 565 <tr>
 566 <td><code>favorited</code></td>
 567 <td>Boolean</td>
 568 <td align="center">No</td>
 569 </tr>
 570
 571 <tr>
 572 <td><code>user</code></td>
 573 <td><a href="help/API-Entities#Contact">Contact</a></td>
 574 <td align="center">No</td>
 575 </tr>
 576
 577 <tr>
 578 <td><code>friendica_author</code></td>
 579 <td><a href="help/API-Entities#Contact">Contact</a></td>
 580 <td align="center">No</td>
 581 </tr>
 582
 583 <tr>
 584 <td><code>friendica_owner</code></td>
 585 <td>
 586
 587 <a href="help/API-Entities#Contact">Contact</a></td>
 588 <td align="center">No</td>
 589 </tr>
 590
 591 <tr>
 592 <td><code>friendica_private</code></td>
 593 <td>Boolean</td>
 594 <td align="center">No</td>
 595 </tr>
 596
 597 <tr>
 598 <td><code>statusnet_html</code></td>
 599 <td>String (HTML)</td>
 600 <td align="center">No</td>
 601 </tr>
 602
 603 <tr>
 604 <td><code>statusnet_conversation_id</code></td>
 605 <td>Integer</td>
 606 <td align="center">No</td>
 607 </tr>
 608
 609 <tr>
 610 <td><code>external_url</code></td>
 611 <td>String (URL)</td>
 612 <td align="center">No</td>
 613 </tr>
 614
 615 <tr>
 616 <td><code>friendica_activities</code></td>
 617 <td><a href="help/API-Entities#Activities">Activities</a></td>
 618 <td align="center">No</td>
 619 </tr>
 620
 621 <tr>
 622 <td><code>friendica_title</code></td>
 623 <td>String (Plaintext)</td>
 624 <td align="center">No</td>
 625 </tr>
 626
 627 <tr>
 628 <td><code>friendica_html</code></td>
 629 <td>String (HTML)</td>
 630 <td align="center">No</td>
 631 </tr>
 632
 633 <tr>
 634 <td><code>attachments</code></td>
 635 <td>List of <a href="help/API-Entities#Attachment">Attachments</a></td>
 636 <td align="center">Yes</td>
 637 </tr>
 638
 639 <tr>
 640 <td><code>entities</code></td>
 641 <td><a href="help/API-Entities#Entities">Entities</a></td>
 642 <td align="center">Yes</td>
 643 </tr>
 644
 645 </tbody>
 646 </table>
 647
 648 ## Media
 649
 650 Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/entities-object#media).
 651
 652 <table class="table table-condensed table-striped table-bordered">
 653 <thead>
 654 <tr>
 655 <th>Attribute</th>
 656 <th>Type</th>
 657 <th align="center">Nullable</th>
 658 </tr>
 659 </thead>
 660 <tbody>
 661
 662 <tr>
 663 <td><code>id</code></td>
 664 <td>Integer</td>
 665 <td align="center">No</td>
 666 </tr>
 667
 668 <tr>
 669 <td><code>id_str</code></td>
 670 <td>String</td>
 671 <td align="center">No</td>
 672 </tr>
 673
 674 <tr>
 675 <td><code>indices</code></td>
 676 <td>List of Integer</td>
 677 <td align="center">No</td>
 678 </tr>
 679
 680 <tr>
 681 <td><code>media_url</code></td>
 682 <td>String (URL)</td>
 683 <td align="center">No</td>
 684 </tr>
 685
 686 <tr>
 687 <td><code>media_url_https</code></td>
 688 <td>String (URL)</td>
 689 <td align="center">No</td>
 690 </tr>
 691
 692 <tr>
 693 <td><code>url</code></td>
 694 <td>String (URL)</td>
 695 <td align="center">No</td>
 696 </tr>
 697
 698 <tr>
 699 <td><code>display_url</code></td>
 700 <td>String (URL)</td>
 701 <td align="center">No</td>
 702 </tr>
 703
 704 <tr>
 705 <td><code>expanded_url</code></td>
 706 <td>String (URL)</td>
 707 <td align="center">No</td>
 708 </tr>
 709
 710 <tr>
 711 <td><code>ext_alt_text</code></td>
 712 <td>String</td>
 713 <td align="center">No</td>
 714 </tr>
 715
 716 <tr>
 717 <td><code>type</code></td>
 718 <td>String</td>
 719 <td align="center">No</td>
 720 </tr>
 721
 722 <tr>
 723 <td><code>sizes</code></td>
 724 <td><a href="help/API-Entities#Sizes">Sizes</a></td>
 725 <td align="center">No</td>
 726 </tr>
 727
 728 </tbody>
 729 </table>
 730
 731 ## Notification
 732
 733 <table class="table table-condensed table-striped table-bordered">
 734 <thead>
 735 <tr>
 736 <th>Attribute</th>
 737 <th>Type</th>
 738 <th>Description</th>
 739 </tr>
 740 </thead>
 741 <tbody>
 742
 743 <tr>
 744 <td><code>id</code></td>
 745 <td>Integer</td>
 746 <td></td>
 747 </tr>
 748
 749 <tr>
 750 <td><code>hash</code></td>
 751 <td>String</td>
 752 <td></td>
 753 </tr>
 754
 755 <tr>
 756 <td><code>type</code></td>
 757 <td>Integer</td>
 758 <td><ul>
 759 <li>1: Inbound follow request</li>
 760 <li>2: Outbound follow request confirmation</li>
 761 <li>4: Wall-to-wall post</li>
 762 <li>8: Reply</li>
 763 <li>16: Private message</li>
 764 <li>32: Friend suggestion</li>
 765 <li>64: Unused</li>
 766 <li>128: Mention</li>
 767 <li>256: Tag added to a post</li>
 768 <li>512: Poke (Obsolete)</li>
 769 <li>1024: New post</li>
 770 <li>16384: System email</li>
 771 <li>32768: System event</li>
 772 </ul></td>
 773 </tr>
 774
 775 <tr>
 776 <td><code>name</code></td>
 777 <td>String</td>
 778 <td>Full name of the contact subject</td>
 779 </tr>
 780
 781 <tr>
 782 <td><code>url</code></td>
 783 <td>String (URL)</td>
 784 <td>Profile page URL of the contact subject</td>
 785 </tr>
 786
 787 <tr>
 788 <td><code>photo</code></td>
 789 <td>String (URL)</td>
 790 <td>Profile photo URL of the contact subject</td>
 791 </tr>
 792
 793 <tr>
 794 <td><code>date</code></td>
 795 <td>String (Date)</td>
 796 <td><code>YYYY-MM-DD hh:mm:ss</code> local server time</td>
 797 </tr>
 798
 799 <tr>
 800 <td><code>msg</code></td>
 801 <td>String (BBCode)</td>
 802 <td></td>
 803 </tr>
 804
 805 <tr>
 806 <td><code>uid</code></td>
 807 <td>Integer</td>
 808 <td>Owner User Id</td>
 809 </tr>
 810
 811 <tr>
 812 <td><code>link</code></td>
 813 <td>String (URL)</td>
 814 <td>Notification URL</td>
 815 </tr>
 816
 817 <tr>
 818 <td><code>iid</code></td>
 819 <td>Integer</td>
 820 <td>Item Id</td>
 821 </tr>
 822
 823 <tr>
 824 <td><code>parent</code></td>
 825 <td>Integer</td>
 826 <td>Parent Item Id</td>
 827 </tr>
 828
 829 <tr>
 830 <td><code>seen</code></td>
 831 <td>Integer (Boolean)</td>
 832 <td>Whether the notification was read or not.</td>
 833 </tr>
 834
 835 <tr>
 836 <td><code>verb</code></td>
 837 <td>String (URL)</td>
 838 <td>[Activity Streams](http://activitystrea.ms) Verb URL</td>
 839 </tr>
 840
 841 <tr>
 842 <td><code>seen</code></td>
 843 <td>Integer (Boolean)</td>
 844 <td>Whether the notification was read or not.</td>
 845 </tr>
 846
 847 <tr>
 848 <td><code>otype</code></td>
 849 <td>Enum</td>
 850 <td>Subject type (`item`, `intro` or `mail`)</td>
 851 </tr>
 852
 853 <tr>
 854 <td><code>name_cache</code></td>
 855 <td>String (HTML)</td>
 856 <td>Full name of the contact subject</td>
 857 </tr>
 858
 859 <tr>
 860 <td><code>msg_cache</code></td>
 861 <td>String (Plaintext)</td>
 862 <td>Plaintext version of the notification text with a placeholder (`{0}`) for the subject contact's name.</td>
 863 </tr>
 864
 865 <tr>
 866 <td><code>timestamp</code></td>
 867 <td>Integer</td>
 868 <td>Unix timestamp</td>
 869 </tr>
 870
 871 <tr>
 872 <td><code>date_rel</code></td>
 873 <td>String</td>
 874 <td>Time since the note was posted, eg "1 hour ago"</td>
 875 </tr>
 876
 877
 878 <tr>
 879 <td><code>msg_html</code></td>
 880 <td>String (HTML)</td>
 881 <td></td>
 882 </tr>
 883
 884 <tr>
 885 <td><code>msg_plain</code></td>
 886 <td>String (Plaintext)</td>
 887 <td></td>
 888 </tr>
 889
 890 </tbody>
 891 </table>
 892
 893 ## Photo
 894
 895 <table class="table table-condensed table-striped table-bordered">
 896 <thead>
 897 <tr>
 898 <th>Attribute</th>
 899 <th>Type</th>
 900 <th>Description</th>
 901 </tr>
 902 </thead>
 903 <tbody>
 904
 905 <tr>
 906 <td><code>id</code></td>
 907 <td>String</td>
 908 <td>Resource ID (32 hex chars)</td>
 909 </tr>
 910
 911 <tr>
 912 <td><code>media-id</code></td>
 913 <td>String (Integer) </td>
 914 <td>ID used for attaching images to a Mastodon Post Status</td>
 915 </tr>
 916
 917
 918 <tr>
 919 <td><code>created</code></td>
 920 <td>String (Date)</td>
 921 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
 922 </tr>
 923
 924 <tr>
 925 <td><code>edited</code></td>
 926 <td>String (Date)</td>
 927 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
 928 </tr>
 929
 930 <tr>
 931 <td><code>title</code></td>
 932 <td>String</td>
 933 <td></td>
 934 </tr>
 935
 936 <tr>
 937 <td><code>desc</code></td>
 938 <td>String (Plaintext)</td>
 939 <td>Picture caption</td>
 940 </tr>
 941
 942 <tr>
 943 <td><code>album</code></td>
 944 <td>String</td>
 945 <td>Album name</td>
 946 </tr>
 947
 948 <tr>
 949 <td><code>filename</code></td>
 950 <td>String</td>
 951 <td>Original image filename</td>
 952 </tr>
 953
 954 <tr>
 955 <td><code>type</code></td>
 956 <td>String</td>
 957 <td>MIME Type</td>
 958 </tr>
 959
 960 <tr>
 961 <td><code>height</code></td>
 962 <td>Integer</td>
 963 <td>Image height in pixels</td>
 964 </tr>
 965
 966 <tr>
 967 <td><code>width</code></td>
 968 <td>Integer</td>
 969 <td>Image width in pixels</td>
 970 </tr>
 971
 972 <tr>
 973 <td><code>profile</code></td>
 974 <td>Integer</td>
 975 <td>1 if it is a profile photo</td>
 976 </tr>
 977
 978 <tr>
 979 <td><code>allow_cid</code></td>
 980 <td>String (ACL)</td>
 981 <td>List of contact ids wrapped in angle brackets allowed to access the photo.</td>
 982 </tr>
 983
 984 <tr>
 985 <td><code>allow_gid</code></td>
 986 <td>String (ACL)</td>
 987 <td>List of contact circle ids wrapped in angle brackets allowed to access the photo.</td>
 988 </tr>
 989
 990 <tr>
 991 <td><code>deny_cid</code></td>
 992 <td>String (ACL)</td>
 993 <td>List of contact ids wrapped in angle brackets forbidden to access the photo.</td>
 994 </tr>
 995
 996 <tr>
 997 <td><code>deny_gid</code></td>
 998 <td>String (ACL)</td>
 999 <td>List of contact circle ids wrapped in angle brackets forbidden to access the photo.</td>
1000 </tr>
1001
1002 <tr>
1003 <td><code>link</code></td>
1004 <td>Array of Strings (URL)</td>
1005 <td>
1006 URLs to the different scales indexed by scale number if no specific scale was requested.
1007 Mutually exclusive with <code>data</code> <code>datasize</code>.
1008 </td>
1009 </tr>
1010
1011 <tr>
1012 <td><code>scales</code></td>
1013 <td>Array of Photo Scales</td>
1014 <td>
1015 List of the various resized versions of the Photo
1016 </td>
1017 </tr>
1018
1019 <tr>
1020 <td><code>datasize</code></td>
1021 <td>Integer</td>
1022 <td>
1023 Picture size in bytes if a single scale was requested.
1024 Mutually exclusive with <code>link</code>.
1025 </td>
1026 </tr>
1027
1028 <tr>
1029 <td><code>data</code></td>
1030 <td>String</td>
1031 <td>
1032 Base64-encoded image data if a single scale was requested.
1033 Mutually exclusive with <code>link</code>.
1034 </td>
1035 </tr>
1036
1037 <tr>
1038 <td><code>friendica_activities</code></td>
1039 <td><a href="help/API-Entities#Activities">Activities</a></td>
1040 <td></td>
1041 </tr>
1042
1043 <tr>
1044 <td><code>friendica_comments</code></td>
1045 <td>List of <a href="help/API-Entities#Item">Items</a></td>
1046 <td></td>
1047 </tr>
1048
1049 <tr>
1050 <td><code>rights_mismatch</code></td>
1051 <td>Boolean</td>
1052 <td>True if the ACL differs between the picture and the associated item.</td>
1053 </tr>
1054
1055 </tbody>
1056 </table>
1057
1058 ## Photo Scale
1059
1060 <table class="table table-condensed table-striped table-bordered">
1061 <thead>
1062 <tr>
1063 <th>Attribute</th>
1064 <th>Type</th>
1065 <th align="center">Nullable</th>
1066 </tr>
1067 </thead>
1068 <tbody>
1069
1070 <tr>
1071 <td><code>id</code></td>
1072 <td>String (Integer)</td>
1073 <td>Row ID of this photo scale</td>
1074 </tr>
1075
1076 <tr>
1077 <td><code>scale</code></td>
1078 <td>Integer</td>
1079 <td>Scale number</td>
1080 </tr>
1081
1082 <tr>
1083 <td><code>link</code></td>
1084 <td>String (URL)</td>
1085 <td>URL to this scale's image</td>
1086 </tr>
1087
1088 <tr>
1089 <td><code>height</code></td>
1090 <td>Integer</td>
1091 <td>Image height in pixels</td>
1092 </tr>
1093
1094 <tr>
1095 <td><code>width</code></td>
1096 <td>Integer</td>
1097 <td>Image width in pixels</td>
1098 </tr>
1099
1100 <tr>
1101 <td><code>size</code></td>
1102 <td>Integer</td>
1103 <td>Image size in bytes</td>
1104 </tr>
1105
1106 </tbody>
1107 </table>
1108
1109
1110 ## Photo List Item
1111
1112 <table class="table table-condensed table-striped table-bordered">
1113 <thead>
1114 <tr>
1115 <th>Attribute</th>
1116 <th>Type</th>
1117 <th>Description</th>
1118 </tr>
1119 </thead>
1120 <tbody>
1121
1122 <tr>
1123 <td><code>id</code></td>
1124 <td>String</td>
1125 <td>Resource ID (32 hex chars)</td>
1126 </tr>
1127
1128 <tr>
1129 <td><code>album</code></td>
1130 <td>String</td>
1131 <td>Album name</td>
1132 </tr>
1133
1134 <tr>
1135 <td><code>filename</code></td>
1136 <td>String</td>
1137 <td>Original image filename</td>
1138 </tr>
1139
1140 <tr>
1141 <td><code>type</code></td>
1142 <td>String</td>
1143 <td>MIME Type</td>
1144 </tr>
1145
1146 <tr>
1147 <td><code>created</code></td>
1148 <td>String (Date)</td>
1149 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
1150 </tr>
1151
1152 <tr>
1153 <td><code>edited</code></td>
1154 <td>String (Date)</td>
1155 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
1156 </tr>
1157
1158 <tr>
1159 <td><code>desc</code></td>
1160 <td>String (Plaintext)</td>
1161 <td>Picture caption</td>
1162 </tr>
1163
1164 <tr>
1165 <td><code>thumb</code></td>
1166 <td>String (URL)</td>
1167 <td>URL of the smallest scale version of the picture.</td>
1168 </tr>
1169
1170 </tbody>
1171 </table>
1172
1173
1174 ## Photo Album
1175
1176 <table class="table table-condensed table-striped table-bordered">
1177 <thead>
1178 <tr>
1179 <th>Attribute</th>
1180 <th>Type</th>
1181 <th>Description</th>
1182 </tr>
1183 </thead>
1184 <tbody>
1185
1186 <tr>
1187 <td><code>name</code></td>
1188 <td>String</td>
1189 <td>The name of the photo album</td>
1190 </tr>
1191
1192 <tr>
1193 <td><code>created</code></td>
1194 <td>String (Date)</td>
1195 <td>The creation date of the album. Format <code>YYYY-MM-DD HH:MM:SS</code></td>
1196 </tr>
1197
1198 <tr>
1199 <td><code>count</code></td>
1200 <td>Integer</td>
1201 <td>The number of images in the album</td>
1202 </tr>
1203
1204 </tbody>
1205 </table>
1206
1207 ## Private message
1208
1209 <table class="table table-condensed table-striped table-bordered">
1210 <thead>
1211 <tr>
1212 <th>Attribute</th>
1213 <th>Type</th>
1214 <th>Description</th>
1215 </tr>
1216 </thead>
1217 <tbody>
1218
1219 <tr>
1220 <td><code>id</code></td>
1221 <td>Integer</td>
1222 <td></td>
1223 </tr>
1224
1225 <tr>
1226 <td><code>sender_id</code></td>
1227 <td>Integer</td>
1228 <td>Sender Contact Id</td>
1229 </tr>
1230
1231 <tr>
1232 <td><code>text</code></td>
1233 <td>String</td>
1234 <td>Can be HTML or plaintext depending on the API call parameter `getText`.</td>
1235 </tr>
1236
1237 <tr>
1238 <td><code>recipient_id</code></td>
1239 <td>Integer</td>
1240 <td>Recipient Contact Id</td>
1241 </tr>
1242
1243 <tr>
1244 <td><code>created_at</code></td>
1245 <td>String (Date)</td>
1246 <td>Ex: Wed May 23 06:01:13 +0000 2007</td>
1247 </tr>
1248
1249 <tr>
1250 <td><code>sender_screen_name</code></td>
1251 <td>String</td>
1252 <td></td>
1253 </tr>
1254
1255 <tr>
1256 <td><code>recipient_screen_name</code></td>
1257 <td>String</td>
1258 <td></td>
1259 </tr>
1260
1261 <tr>
1262 <td><code>sender</code></td>
1263 <td><a href="help/API-Entities#Contact">Contact</a></td>
1264 <td></td>
1265 </tr>
1266
1267 <tr>
1268 <td><code>recipient</code></td>
1269 <td><a href="help/API-Entities#Contact">Contact</a></td>
1270 <td></td>
1271 </tr>
1272
1273 <tr>
1274 <td><code>title</code></td>
1275 <td>String</td>
1276 <td>Empty if the API call parameter `getText` is empty or absent.</td>
1277 </tr>
1278
1279 <tr>
1280 <td><code>friendica_seen</code></td>
1281 <td>Integer (Boolean)</td>
1282 <td>Whether the private message has been read or not.</td>
1283 </tr>
1284
1285 <tr>
1286 <td><code>friendica_parent_uri</code></td>
1287 <td>String</td>
1288 <td></td>
1289 </tr>
1290
1291 </tbody>
1292 </table>
1293
1294 ## Profile
1295
1296 <table class="table table-condensed table-striped table-bordered">
1297 <thead>
1298 <tr>
1299 <th>Attribute</th>
1300 <th>Type</th>
1301 <th>Description</th>
1302 </tr>
1303 </thead>
1304 <tbody>
1305
1306 <tr>
1307 <td><code>profile_id</code></td>
1308 <td>Integer</td>
1309 <td></td>
1310 </tr>
1311
1312 <tr>
1313 <td><code>profile_name</code></td>
1314 <td>String</td>
1315 <td></td>
1316 </tr>
1317
1318 <tr>
1319 <td><code>is_default</code></td>
1320 <td>Boolean</td>
1321 <td></td>
1322 </tr>
1323
1324 <tr>
1325 <td><code>hide_friends</code></td>
1326 <td>Boolean</td>
1327 <td>Whether the user chose to hide their contact list on their profile.</td>
1328 </tr>
1329
1330 <tr>
1331 <td><code>profile_photo</code></td>
1332 <td>String (URL)</td>
1333 <td>Largest size profile picture URL.</td>
1334 </tr>
1335
1336 <tr>
1337 <td><code>profile_thumb</code></td>
1338 <td>String (URL)</td>
1339 <td>Smallest size profile picture URL.</td>
1340 </tr>
1341
1342 <tr>
1343 <td><code>publish</code></td>
1344 <td>Boolean</td>
1345 <td>Whether the user chose to publish their profile in the local directory.</td>
1346 </tr>
1347
1348 <tr>
1349 <td><code>net_publish</code></td>
1350 <td>Boolean</td>
1351 <td>Whether the user chose to publish their profile in the global directory.</td>
1352 </tr>
1353
1354 <tr>
1355 <td><code>description</code></td>
1356 <td>String</td>
1357 <td></td>
1358 </tr>
1359
1360 <tr>
1361 <td><code>date_of_birth</code></td>
1362 <td>String</td>
1363 <td></td>
1364 </tr>
1365
1366 <tr>
1367 <td><code>address</code></td>
1368 <td>String</td>
1369 <td></td>
1370 </tr>
1371
1372 <tr>
1373 <td><code>city</code></td>
1374 <td>String</td>
1375 <td></td>
1376 </tr>
1377
1378 <tr>
1379 <td><code>region</code></td>
1380 <td>String</td>
1381 <td></td>
1382 </tr>
1383
1384 <tr>
1385 <td><code>postal_code</code></td>
1386 <td>String</td>
1387 <td></td>
1388 </tr>
1389
1390 <tr>
1391 <td><code>country</code></td>
1392 <td>String</td>
1393 <td></td>
1394 </tr>
1395
1396 <tr>
1397 <td><code>public_keywords</code></td>
1398 <td>String</td>
1399 <td>Comma-separated list of words meant to be displayed as hashtags.</td>
1400 </tr>
1401
1402 <tr>
1403 <td><code>private_keywords</code></td>
1404 <td>String</td>
1405 <td>Comma-separated list of words meant to be used for search only.</td>
1406 </tr>
1407
1408 <tr>
1409 <td><code>homepage</code></td>
1410 <td>String (URL)</td>
1411 <td></td>
1412 </tr>
1413
1414 </tbody>
1415 </table>
1416
1417 ## Size
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 <table class="table table-condensed table-striped table-bordered">
1429 <thead>
1430 <tr>
1431 <th>Attribute</th>
1432 <th>Type</th>
1433 <th align="center">Nullable</th>
1434 </tr>
1435 </thead>
1436 <tbody>
1437
1438 <tr>
1439 <td><code>w</code></td>
1440 <td>Integer</td>
1441 <td align="center">No</td>
1442 </tr>
1443
1444 <tr>
1445 <td><code>h</code></td>
1446 <td>Integer</td>
1447 <td align="center">No</td>
1448 </tr>
1449
1450 <tr>
1451 <td><code>resize</code></td>
1452 <td>Enum (fit, crop)</td>
1453 <td align="center">Yes</td>
1454 </tr>
1455
1456 </tbody>
1457 </table>
1458
1459
1460 ## Sizes
1461
1462 <table class="table table-condensed table-striped table-bordered">
1463 <thead>
1464 <tr>
1465 <th>Attribute</th>
1466 <th>Type</th>
1467 <th align="center">Nullable</th>
1468 </tr>
1469 </thead>
1470 <tbody>
1471
1472 <tr>
1473 <td><code>medium</code></td>
1474 <td><a href="help/API-Entities#Size">Size</a></td>
1475 <td align="center">No</td>
1476 </tr>
1477
1478 <tr>
1479 <td><code>large</code></td>
1480 <td><a href="help/API-Entities#Size">Size</a></td>
1481 <td align="center">Yes</td>
1482 </tr>
1483
1484 <tr>
1485 <td><code>thumb</code></td>
1486 <td><a href="help/API-Entities#Size">Size</a></td>
1487 <td align="center">Yes</td>
1488 </tr>
1489
1490 <tr>
1491 <td><code>small</code></td>
1492 <td><a href="help/API-Entities#Size">Size</a></td>
1493 <td align="center">Yes</td>
1494 </tr>
1495
1496 </tbody>
1497 </table>
1498
1499 ## Symbol
1500
1501 Unused
1502
1503 ## URL
1504
1505 <table class="table table-condensed table-striped table-bordered">
1506 <thead>
1507 <tr>
1508 <th>Attribute</th>
1509 <th>Type</th>
1510 <th align="center">Nullable</th>
1511 </tr>
1512 </thead>
1513 <tbody>
1514
1515 <tr>
1516 <td><code>url</code></td>
1517 <td>String (URL)</td>
1518 <td align="center">No</td>
1519 </tr>
1520
1521 <tr>
1522 <td><code>expanded_url</code></td>
1523 <td>String (URL)</td>
1524 <td align="center">No</td>
1525 </tr>
1526
1527 <tr>
1528 <td><code>display_url</code></td>
1529 <td>String (URL)</td>
1530 <td align="center">No</td>
1531 </tr>
1532
1533 <tr>
1534 <td><code>indices</code></td>
1535 <td>List of Integer</td>
1536 <td align="center">No</td>
1537 </tr>
1538
1539 </tbody>
1540 </table>
1541
1542 ## User Mention
1543
1544 Unused