1 # Friendica API entities
4 * [Using the APIs](help/api)
9 <table class="table table-condensed table-striped table-bordered">
14 <th align="center">Nullable</th>
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>
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>
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>
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>
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>
54 <table class="table table-condensed table-striped table-bordered">
59 <th align="center">Nullable</th>
65 <td><code>url</code></td>
67 <td align="center">No</td>
71 <td><code>mimetype</code></td>
73 <td align="center">No</td>
77 <td><code>size</code></td>
78 <td>Integer (bytes)</td>
79 <td align="center">No</td>
87 <table class="table table-condensed table-striped table-bordered">
92 <th align="center">Nullable</th>
98 <td><code>id</code></td>
100 <td align="center">No</td>
104 <td><code>id_str</code></td>
106 <td align="center">No</td>
110 <td><code>name</code></td>
112 <td align="center">No</td>
116 <td><code>screen_name</code></td>
118 <td align="center">No</td>
122 <td><code>location</code></td>
124 <td align="center">No</td>
128 <td><code>description</code></td>
130 <td align="center">No</td>
134 <td><code>profile_image_url</code></td>
135 <td>String (URL)</td>
136 <td align="center">No</td>
140 <td><code>profile_image_url_https</code></td>
141 <td>String (URL)</td>
142 <td align="center">No</td>
146 <td><code>profile_image_url_profile_size</code></td>
147 <td>String (URL)</td>
148 <td align="center">No</td>
152 <td><code>profile_image_url_large</code></td>
153 <td>String (URL)</td>
154 <td align="center">No</td>
158 <td><code>url</code></td>
159 <td>String (URL)</td>
160 <td align="center">No</td>
164 <td><code>protected</code></td>
166 <td align="center">No</td>
170 <td><code>followers_count</code></td>
172 <td align="center">No</td>
176 <td><code>friends_count</code></td>
178 <td align="center">No</td>
182 <td><code>listed_count</code></td>
184 <td align="center">No</td>
188 <td><code>favourites_count</code></td>
190 <td align="center">No</td>
194 <td><code>statuses_count</code></td>
196 <td align="center">No</td>
200 <td><code>created_at</code></td>
201 <td>String (Date)<br/>
202 Ex: Wed May 23 06:01:13 +0000 2007
204 <td align="center">No</td>
208 <td><code>utc_offset</code></td>
210 <td align="center">No</td>
214 <td><code>time_zone</code></td>
216 <td align="center">No</td>
220 <td><code>geo_enabled</code></td>
222 <td align="center">No</td>
226 <td><code>verified</code></td>
228 <td align="center">No</td>
232 <td><code>lang</code></td>
234 <td align="center">No</td>
238 <td><code>contributors_enabled</code></td>
240 <td align="center">No</td>
244 <td><code>is_translator</code></td>
246 <td align="center">No</td>
250 <td><code>is_translation_enabled</code></td>
252 <td align="center">No</td>
256 <td><code>following</code></td>
258 <td align="center">No</td>
262 <td><code>follow_request_sent</code></td>
264 <td align="center">No</td>
268 <td><code>statusnet_blocking</code></td>
270 <td align="center">No</td>
274 <td><code>notifications</code></td>
276 <td align="center">No</td>
280 <td><code>statusnet_profile_url</code></td>
281 <td>String (URL)</td>
282 <td align="center">No</td>
286 <td><code>uid</code></td>
288 <td align="center">No</td>
292 <td><code>cid</code></td>
294 <td align="center">No</td>
298 <td><code>pid</code></td>
300 <td align="center">No</td>
304 <td><code>self</code></td>
306 <td align="center">No</td>
310 <td><code>network</code></td>
312 <td align="center">No</td>
321 <table class="table table-condensed table-striped table-bordered">
326 <th align="center">Nullable</th>
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>
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>
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>
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>
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>
370 <table class="table table-condensed table-striped table-bordered">
375 <th align="center">Nullable</th>
381 <td><code>text</code></td>
382 <td>String (Plaintext)</td>
383 <td align="center">No</td>
387 <td><code>truncated</code></td>
389 <td align="center">No</td>
393 <td><code>created_at</code></td>
394 <td>String (Date)<br/>
395 Ex: Wed May 23 06:01:13 +0000 2007
397 <td align="center">No</td>
401 <td><code>in_reply_to_status_id</code></td>
403 <td align="center">No</td>
407 <td><code>in_reply_to_status_id_str</code></td>
409 <td align="center">No</td>
413 <td><code>source</code></td>
415 <td align="center">No</td>
419 <td><code>id</code></td>
421 <td align="center">No</td>
425 <td><code>id_str</code></td>
427 <td align="center">No</td>
431 <td><code>in_reply_to_user_id</code></td>
433 <td align="center">No</td>
437 <td><code>in_reply_to_user_id_str</code></td>
439 <td align="center">No</td>
443 <td><code>in_reply_to_screen_name</code></td>
445 <td align="center">No</td>
449 <td><code>geo</code></td>
451 <td align="center">Yes</td>
455 <td><code>favorited</code></td>
457 <td align="center">No</td>
461 <td><code>user</code></td>
462 <td><a href="help/API-Entities#Contact">Contact</a></td>
463 <td align="center">No</td>
467 <td><code>friendica_author</code></td>
468 <td><a href="help/API-Entities#Contact">Contact</a></td>
469 <td align="center">No</td>
473 <td><code>friendica_owner</code></td>
476 <a href="help/API-Entities#Contact">Contact</a></td>
477 <td align="center">No</td>
481 <td><code>friendica_private</code></td>
483 <td align="center">No</td>
487 <td><code>statusnet_html</code></td>
488 <td>String (HTML)</td>
489 <td align="center">No</td>
493 <td><code>statusnet_conversation_id</code></td>
495 <td align="center">No</td>
499 <td><code>external_url</code></td>
500 <td>String (URL)</td>
501 <td align="center">No</td>
505 <td><code>friendica_activities</code></td>
506 <td><a href="help/API-Entities#Activities">Activities</a></td>
507 <td align="center">No</td>
511 <td><code>friendica_title</code></td>
512 <td>String (Plaintext)</td>
513 <td align="center">No</td>
517 <td><code>friendica_html</code></td>
518 <td>String (HTML)</td>
519 <td align="center">No</td>
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>
529 <td><code>entities</code></td>
530 <td><a href="help/API-Entities#Entities">Entities</a></td>
531 <td align="center">Yes</td>
539 Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/entities-object#media).
541 <table class="table table-condensed table-striped table-bordered">
546 <th align="center">Nullable</th>
552 <td><code>id</code></td>
554 <td align="center">No</td>
558 <td><code>id_str</code></td>
560 <td align="center">No</td>
564 <td><code>indices</code></td>
565 <td>List of Integer</td>
566 <td align="center">No</td>
570 <td><code>media_url</code></td>
571 <td>String (URL)</td>
572 <td align="center">No</td>
576 <td><code>media_url_https</code></td>
577 <td>String (URL)</td>
578 <td align="center">No</td>
582 <td><code>url</code></td>
583 <td>String (URL)</td>
584 <td align="center">No</td>
588 <td><code>display_url</code></td>
589 <td>String (URL)</td>
590 <td align="center">No</td>
594 <td><code>expanded_url</code></td>
595 <td>String (URL)</td>
596 <td align="center">No</td>
600 <td><code>ext_alt_text</code></td>
602 <td align="center">No</td>
606 <td><code>type</code></td>
608 <td align="center">No</td>
612 <td><code>sizes</code></td>
613 <td><a href="help/API-Entities#Sizes">Sizes</a></td>
614 <td align="center">No</td>
622 <table class="table table-condensed table-striped table-bordered">
633 <td><code>id</code></td>
639 <td><code>hash</code></td>
645 <td><code>type</code></td>
648 <li>1: Inbound follow request</li>
649 <li>2: Outbound follow request confirmation</li>
650 <li>4: Wall-to-wall post</li>
652 <li>16: Private message</li>
653 <li>32: Friend suggestion</li>
655 <li>128: Mention</li>
656 <li>256: Tag added to a post</li>
658 <li>1024: New post</li>
659 <li>16384: System email</li>
660 <li>32768: System event</li>
665 <td><code>name</code></td>
667 <td>Full name of the contact subject</td>
671 <td><code>url</code></td>
672 <td>String (URL)</td>
673 <td>Profile page URL of the contact subject</td>
677 <td><code>photo</code></td>
678 <td>String (URL)</td>
679 <td>Profile photo URL of the contact subject</td>
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>
689 <td><code>msg</code></td>
690 <td>String (BBCode)</td>
695 <td><code>uid</code></td>
697 <td>Owner User Id</td>
701 <td><code>link</code></td>
702 <td>String (URL)</td>
703 <td>Notification URL</td>
707 <td><code>iid</code></td>
713 <td><code>parent</code></td>
715 <td>Parent Item Id</td>
719 <td><code>seen</code></td>
720 <td>Integer (Boolean)</td>
721 <td>Whether the notification was read or not.</td>
725 <td><code>verb</code></td>
726 <td>String (URL)</td>
727 <td>[Activity Streams](http://activitystrea.ms) Verb URL</td>
731 <td><code>seen</code></td>
732 <td>Integer (Boolean)</td>
733 <td>Whether the notification was read or not.</td>
737 <td><code>otype</code></td>
739 <td>Subject type (`item`, `intro` or `mail`)</td>
743 <td><code>name_cache</code></td>
744 <td>String (HTML)</td>
745 <td>Full name of the contact subject</td>
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>
755 <td><code>timestamp</code></td>
757 <td>Unix timestamp</td>
761 <td><code>date_rel</code></td>
763 <td>Time since the note was posted, eg "1 hour ago"</td>
768 <td><code>msg_html</code></td>
769 <td>String (HTML)</td>
774 <td><code>msg_plain</code></td>
775 <td>String (Plaintext)</td>
784 <table class="table table-condensed table-striped table-bordered">
795 <td><code>id</code></td>
797 <td>Resource ID (32 hex chars)</td>
801 <td><code>created</code></td>
802 <td>String (Date)</td>
803 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
807 <td><code>edited</code></td>
808 <td>String (Date)</td>
809 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
813 <td><code>title</code></td>
819 <td><code>desc</code></td>
820 <td>String (Plaintext)</td>
821 <td>Picture caption</td>
825 <td><code>album</code></td>
831 <td><code>filename</code></td>
833 <td>Original image filename</td>
837 <td><code>type</code></td>
843 <td><code>height</code></td>
845 <td>Image height in pixels</td>
849 <td><code>width</code></td>
851 <td>Image width in pixels</td>
855 <td><code>profile</code></td>
857 <td>1 if it is a profile photo</td>
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>
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>
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>
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>
885 <td><code>link</code></td>
886 <td>Array of Strings (URL)</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>.
894 <td><code>datasize</code></td>
897 Picture size in bytes if a single scale was requested.
898 Mutually exclusive with <code>link</code>.
903 <td><code>data</code></td>
906 Base64-encoded image data if a single scale was requested.
907 Mutually exclusive with <code>link</code>.
912 <td><code>friendica_activities</code></td>
913 <td><a href="help/API-Entities#Activities">Activities</a></td>
918 <td><code>friendica_comments</code></td>
919 <td>List of <a href="help/API-Entities#Item">Items</a></td>
924 <td><code>rights_mismatch</code></td>
926 <td>True if the ACL differs between the picture and the associated item.</td>
934 <table class="table table-condensed table-striped table-bordered">
945 <td><code>id</code></td>
947 <td>Resource ID (32 hex chars)</td>
951 <td><code>album</code></td>
957 <td><code>filename</code></td>
959 <td>Original image filename</td>
963 <td><code>type</code></td>
969 <td><code>created</code></td>
970 <td>String (Date)</td>
971 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
975 <td><code>edited</code></td>
976 <td>String (Date)</td>
977 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
981 <td><code>desc</code></td>
982 <td>String (Plaintext)</td>
983 <td>Picture caption</td>
987 <td><code>thumb</code></td>
988 <td>String (URL)</td>
989 <td>URL of the smallest scale version of the picture.</td>
997 <table class="table table-condensed table-striped table-bordered">
1002 <th>Description</th>
1008 <td><code>id</code></td>
1014 <td><code>sender_id</code></td>
1016 <td>Sender Contact Id</td>
1020 <td><code>text</code></td>
1022 <td>Can be HTML or plaintext depending on the API call parameter `getText`.</td>
1026 <td><code>recipient_id</code></td>
1028 <td>Recipient Contact Id</td>
1032 <td><code>created_at</code></td>
1033 <td>String (Date)</td>
1034 <td>Ex: Wed May 23 06:01:13 +0000 2007</td>
1038 <td><code>sender_screen_name</code></td>
1044 <td><code>recipient_screen_name</code></td>
1050 <td><code>sender</code></td>
1051 <td><a href="help/API-Entities#Contact">Contact</a></td>
1056 <td><code>recipient</code></td>
1057 <td><a href="help/API-Entities#Contact">Contact</a></td>
1062 <td><code>title</code></td>
1064 <td>Empty if the API call parameter `getText` is empty or absent.</td>
1068 <td><code>friendica_seen</code></td>
1069 <td>Integer (Boolean)</td>
1070 <td>Whether the private message has been read or not.</td>
1074 <td><code>friendica_parent_uri</code></td>
1084 <table class="table table-condensed table-striped table-bordered">
1089 <th>Description</th>
1095 <td><code>profile_id</code></td>
1101 <td><code>profile_name</code></td>
1107 <td><code>is_default</code></td>
1113 <td><code>hide_friends</code></td>
1115 <td>Whether the user chose to hide their contact list on their profile.</td>
1119 <td><code>profile_photo</code></td>
1120 <td>String (URL)</td>
1121 <td>Largest size profile picture URL.</td>
1125 <td><code>profile_thumb</code></td>
1126 <td>String (URL)</td>
1127 <td>Smallest size profile picture URL.</td>
1131 <td><code>publish</code></td>
1133 <td>Whether the user chose to publish their profile in the local directory.</td>
1137 <td><code>net_publish</code></td>
1139 <td>Whether the user chose to publish their profile in the global directory.</td>
1143 <td><code>description</code></td>
1149 <td><code>date_of_birth</code></td>
1155 <td><code>address</code></td>
1161 <td><code>city</code></td>
1167 <td><code>region</code></td>
1173 <td><code>postal_code</code></td>
1179 <td><code>country</code></td>
1185 <td><code>hometown</code></td>
1191 <td><code>gender</code></td>
1197 <td><code>marital</code></td>
1203 <td><code>marital_with</code></td>
1209 <td><code>marital_since</code></td>
1210 <td>String (Date)</td>
1215 <td><code>sexual</code></td>
1221 <td><code>politic</code></td>
1227 <td><code>religion</code></td>
1233 <td><code>public_keywords</code></td>
1235 <td>Comma-separated list of words meant to be displayed as hashtags.</td>
1239 <td><code>private_keywords</code></td>
1241 <td>Comma-separated list of words meant to be used for search only.</td>
1245 <td><code>likes</code></td>
1246 <td>String (Plaintext)</td>
1251 <td><code>dislikes</code></td>
1252 <td>String (Plaintext)</td>
1257 <td><code>about</code></td>
1258 <td>String (Plaintext)</td>
1263 <td><code>music</code></td>
1264 <td>String (Plaintext)</td>
1269 <td><code>book</code></td>
1270 <td>String (Plaintext)</td>
1275 <td><code>tv</code></td>
1276 <td>String (Plaintext)</td>
1281 <td><code>film</code></td>
1282 <td>String (Plaintext)</td>
1287 <td><code>interest</code></td>
1288 <td>String (Plaintext)</td>
1293 <td><code>romance</code></td>
1294 <td>String (Plaintext)</td>
1299 <td><code>work</code></td>
1300 <td>String (Plaintext)</td>
1305 <td><code>education</code></td>
1306 <td>String (Plaintext)</td>
1311 <td><code>social_networks</code></td>
1312 <td>String (Plaintext)</td>
1317 <td><code>homepage</code></td>
1318 <td>String (URL)</td>
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>
1333 <table class="table table-condensed table-striped table-bordered">
1338 <th align="center">Nullable</th>
1342 <table class="table table-condensed table-striped table-bordered">
1347 <th align="center">Nullable</th>
1353 <td><code>w</code></td>
1355 <td align="center">No</td>
1359 <td><code>h</code></td>
1361 <td align="center">No</td>
1365 <td><code>resize</code></td>
1366 <td>Enum (fit, crop)</td>
1367 <td align="center">Yes</td>
1376 <table class="table table-condensed table-striped table-bordered">
1381 <th align="center">Nullable</th>
1387 <td><code>medium</code></td>
1388 <td><a href="help/API-Entities#Size">Size</a></td>
1389 <td align="center">No</td>
1393 <td><code>large</code></td>
1394 <td><a href="help/API-Entities#Size">Size</a></td>
1395 <td align="center">Yes</td>
1399 <td><code>thumb</code></td>
1400 <td><a href="help/API-Entities#Size">Size</a></td>
1401 <td align="center">Yes</td>
1405 <td><code>small</code></td>
1406 <td><a href="help/API-Entities#Size">Size</a></td>
1407 <td align="center">Yes</td>
1419 <table class="table table-condensed table-striped table-bordered">
1424 <th align="center">Nullable</th>
1430 <td><code>url</code></td>
1431 <td>String (URL)</td>
1432 <td align="center">No</td>
1436 <td><code>expanded_url</code></td>
1437 <td>String (URL)</td>
1438 <td align="center">No</td>
1442 <td><code>display_url</code></td>
1443 <td>String (URL)</td>
1444 <td align="center">No</td>
1448 <td><code>indices</code></td>
1449 <td>List of Integer</td>
1450 <td align="center">No</td>