Friendica API entities

This is an old revision of the document!

# Friendica API entities

* [Home](help)

[Using the APIs](help/api)

## Activities

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody>

like

</td> <td>List of <a href=“help/API-Entities#Contact”>Contacts</a></td> <td align=“center”>No</td> </tr>

dislike

</td> <td>List of <a href=“help/API-Entities#Contact”>Contacts</a></td> <td align=“center”>No</td> </tr>

attendyes

</td> <td>List of <a href=“help/API-Entities#Contact”>Contacts</a></td> <td align=“center”>No</td> </tr>

attendno

</td> <td>List of <a href=“help/API-Entities#Contact”>Contacts</a></td> <td align=“center”>No</td> </tr>

attendmaybe

</td> <td>List of <a href=“help/API-Entities#Contact”>Contacts</a></td> <td align=“center”>No</td> </tr>

</tbody> </table>

## Attachment

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody>

url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

mimetype

</td> <td>String</td> <td align=“center”>No</td> </tr>

size

</td> <td>Integer (bytes)</td> <td align=“center”>No</td> </tr>

</tbody> </table>

## Contact

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead>

id

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

id_str

</td> <td>String</td> <td align=“center”>No</td> </tr>

name

</td> <td>String</td> <td align=“center”>No</td> </tr>

screen_name

</td> <td>String</td> <td align=“center”>No</td> </tr>

location

</td> <td>String</td> <td align=“center”>No</td> </tr>

description

</td> <td>String</td> <td align=“center”>No</td> </tr>

profile_image_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

profile_image_url_https

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

profile_image_url_profile_size

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

profile_image_url_large

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

protected

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

followers_count

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

friends_count

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

listed_count

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

favourites_count

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

statuses_count

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

created_at

</td> <td>String (Date)<br/> Ex: Wed May 23 06:01:13 +0000 2007 </td> <td align=“center”>No</td> </tr>

utc_offset

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

time_zone

</td> <td>String</td> <td align=“center”>No</td> </tr>

geo_enabled

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

verified

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

lang

</td> <td>String</td> <td align=“center”>No</td> </tr>

contributors_enabled

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

is_translator

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

is_translation_enabled

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

following

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

follow_request_sent

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

statusnet_blocking

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

notifications

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

statusnet_profile_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

uid

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

cid

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

pid

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

self

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

network

</td> <td>String</td> <td align=“center”>No</td> </tr>

</tbody> </table>

## Entities

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody>

hashtags

</td> <td>List of <a href=“help/API-Entities#Hashtag”>Hashtags</a></td> <td align=“center”>No</td> </tr>

symbols

</td> <td>List of <a href=“help/API-Entities#Symbol”>Symbols</a></td> <td align=“center”>No</td> </tr>

urls

</td> <td>List of <a href=“help/API-Entities#URL”>URLs</a></td> <td align=“center”>No</td> </tr>

user_mentions

</td> <td>List of <a href=“help/API-Entities#User+Mention”>User mentions</a></td> <td align=“center”>No</td> </tr>

media

</td> <td>List of <a href=“help/API-Entities#Media”>Medias</a></td> <td align=“center”>No</td> </tr>

</tbody> </table>

## Event

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead>

id

</td> <td>Integer</td> <td></td> </tr>

uid

</td> <td>Integer</td> <td>Owner User Id</td> </tr>

cid

</td> <td>Integer</td> <td>Target Contact Id</td> </tr>

uri

</td> <td>String</td> <td>Item unique URI string</td> </tr>

name

</td> <td>String (Plaintext)</td> <td>Title</td> </tr>

desc

</td> <td>String (HTML)</td> <td>Description</td> </tr>

startTime

</td> <td>String (UTC

YYYY-MM-DD HH:II:SS)

)</td> <td></td> </tr>

endTime

</td> <td>String (UTC

YYYY-MM-DD HH:II:SS)

)</td> <td>Optional (null date is

0001-01-01 00:00:00

</td> </tr>

type

</td> <td>String (

event

or

birthday

)</td> <td></td> </tr>

nofinish

</td> <td>Boolean</td> <td>Ongoing event</td> </tr>

place

</td> <td>String</td> <td>Optional. Location.</td> </tr>

adjust

</td> <td>Boolean</td> <td>???</td> </tr>

ignore

</td> <td>Boolean</td> <td>???</td> </tr>

allow_cid

</td> <td>String (angle-brackets escaped integers)</td> <td>Optional. List of allowed contact ids</td> </tr>

allow_gid

</td> <td>String (angle-brackets escaped integers)</td> <td>Optional. List of allowed group ids</td> </tr>

deny_cid

</td> <td>String (angle-brackets escaped integers)</td> <td>Optional. List of disallowed contact ids</td> </tr>

deny_gid

</td> <td>String (angle-brackets escaped integers)</td> <td>Optional. List of disallowed group ids</td> </tr>

</tbody> </table>

## Hashtag

Unused

## Item

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead>

text

</td> <td>String (Plaintext)</td> <td align=“center”>No</td> </tr>

truncated

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

created_at

</td> <td>String (Date)<br/> Ex: Wed May 23 06:01:13 +0000 2007 </td> <td align=“center”>No</td> </tr>

in_reply_to_status_id

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

in_reply_to_status_id_str

</td> <td>String</td> <td align=“center”>No</td> </tr>

source

</td> <td>String</td> <td align=“center”>No</td> </tr>

id

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

id_str

</td> <td>String</td> <td align=“center”>No</td> </tr>

in_reply_to_user_id

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

in_reply_to_user_id_str

</td> <td>String</td> <td align=“center”>No</td> </tr>

in_reply_to_screen_name

</td> <td>String</td> <td align=“center”>No</td> </tr>

geo

</td> <td>String</td> <td align=“center”>Yes</td> </tr>

favorited

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

user

</td> <td><a href=“help/API-Entities#Contact”>Contact</a></td> <td align=“center”>No</td> </tr>

friendica_author

</td> <td><a href=“help/API-Entities#Contact”>Contact</a></td> <td align=“center”>No</td> </tr>

friendica_owner

</td> <td>

<a href=“help/API-Entities#Contact”>Contact</a></td> <td align=“center”>No</td> </tr>

friendica_private

</td> <td>Boolean</td> <td align=“center”>No</td> </tr>

statusnet_html

</td> <td>String (HTML)</td> <td align=“center”>No</td> </tr>

statusnet_conversation_id

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

external_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

friendica_activities

</td> <td><a href=“help/API-Entities#Activities”>Activities</a></td> <td align=“center”>No</td> </tr>

friendica_title

</td> <td>String (Plaintext)</td> <td align=“center”>No</td> </tr>

friendica_html

</td> <td>String (HTML)</td> <td align=“center”>No</td> </tr>

attachments

</td> <td>List of <a href=“help/API-Entities#Attachment”>Attachments</a></td> <td align=“center”>Yes</td> </tr>

entities

</td> <td><a href=“help/API-Entities#Entities”>Entities</a></td> <td align=“center”>Yes</td> </tr>

</tbody> </table>

## Media

Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/entities-object#media).

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody>

id

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

id_str

</td> <td>String</td> <td align=“center”>No</td> </tr>

indices

</td> <td>List of Integer</td> <td align=“center”>No</td> </tr>

media_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

media_url_https

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

display_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

expanded_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

ext_alt_text

</td> <td>String</td> <td align=“center”>No</td> </tr>

type

</td> <td>String</td> <td align=“center”>No</td> </tr>

sizes

</td> <td><a href=“help/API-Entities#Sizes”>Sizes</a></td> <td align=“center”>No</td> </tr>

</tbody> </table>

## Notification

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody>

id

</td> <td>Integer</td> <td></td> </tr>

hash

</td> <td>String</td> <td></td> </tr>

type

</td> <td>Integer</td> <td><ul> <li>1: Inbound follow request</li> <li>2: Outbound follow request confirmation</li> <li>4: Wall-to-wall post</li> <li>8: Reply</li> <li>16: Private message</li> <li>32: Friend suggestion</li> <li>64: Unused</li> <li>128: Mention</li> <li>256: Tag added to a post</li> <li>512: Poke</li> <li>1024: New post</li> <li>16384: System email</li> <li>32768: System event</li> </ul></td> </tr>

name

</td> <td>String</td> <td>Full name of the contact subject</td> </tr>

url

</td> <td>String (URL)</td> <td>Profile page URL of the contact subject</td> </tr>

photo

</td> <td>String (URL)</td> <td>Profile photo URL of the contact subject</td> </tr>

date

</td> <td>String (Date)</td> <td>

YYYY-MM-DD hh:mm:ss

local server time</td> </tr>

msg

</td> <td>String (BBCode)</td> <td></td> </tr>

uid

</td> <td>Integer</td> <td>Owner User Id</td> </tr>

link

</td> <td>String (URL)</td> <td>Notification URL</td> </tr>

iid

</td> <td>Integer</td> <td>Item Id</td> </tr>

parent

</td> <td>Integer</td> <td>Parent Item Id</td> </tr>

seen

</td> <td>Integer (Boolean)</td> <td>Whether the notification was read or not.</td> </tr>

verb

</td> <td>String (URL)</td> <td>[Activity Streams](http://activitystrea.ms) Verb URL</td> </tr>

seen

</td> <td>Integer (Boolean)</td> <td>Whether the notification was read or not.</td> </tr>

otype

</td> <td>Enum</td> <td>Subject type (`item`, `intro` or `mail`)</td> </tr>

name_cache

</td> <td>String (HTML)</td> <td>Full name of the contact subject</td> </tr>

msg_cache

</td> <td>String (Plaintext)</td> <td>Plaintext version of the notification text with a placeholder (`{0}`) for the subject contact's name.</td> </tr>

timestamp

</td> <td>Integer</td> <td>Unix timestamp</td> </tr>

date_rel

</td> <td>String</td> <td>Time since the note was posted, eg “1 hour ago”</td> </tr>

msg_html

</td> <td>String (HTML)</td> <td></td> </tr>

msg_plain

</td> <td>String (Plaintext)</td> <td></td> </tr>

</tbody> </table>

## Photo

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody>

id

</td> <td>String</td> <td>Resource ID (32 hex chars)</td> </tr>

created

</td> <td>String (Date)</td> <td>Format

YYYY-MM-DD HH:MM:SS

</td> </tr>

edited

</td> <td>String (Date)</td> <td>Format

YYYY-MM-DD HH:MM:SS

</td> </tr>

title

</td> <td>String</td> <td></td> </tr>

desc

</td> <td>String (Plaintext)</td> <td>Picture caption</td> </tr>

album

</td> <td>String</td> <td>Album name</td> </tr>

filename

</td> <td>String</td> <td>Original image filename</td> </tr>

type

</td> <td>String</td> <td>MIME Type</td> </tr>

height

</td> <td>Integer</td> <td>Image height in pixels</td> </tr>

width

</td> <td>Integer</td> <td>Image width in pixels</td> </tr>

profile

</td> <td>Integer</td> <td>1 if it is a profile photo</td> </tr>

allow_cid

</td> <td>String (ACL)</td> <td>List of contact ids wrapped in angle brackets allowed to access the photo.</td> </tr>

allow_gid

</td> <td>String (ACL)</td> <td>List of contact group ids wrapped in angle brackets allowed to access the photo.</td> </tr>

deny_cid

</td> <td>String (ACL)</td> <td>List of contact ids wrapped in angle brackets forbidden to access the photo.</td> </tr>

deny_gid

</td> <td>String (ACL)</td> <td>List of contact group ids wrapped in angle brackets forbidden to access the photo.</td> </tr>

link

</td> <td>Array of Strings (URL)</td> <td> URLs to the different scales indexed by scale number if no specific scale was requested. Mutually exclusive with

data

datasize

. </td> </tr>

datasize

</td> <td>Integer</td> <td> Picture size in bytes if a single scale was requested. Mutually exclusive with

link

. </td> </tr>

data

</td> <td>String</td> <td> Base64-encoded image data if a single scale was requested. Mutually exclusive with

link

. </td> </tr>

friendica_activities

</td> <td><a href=“help/API-Entities#Activities”>Activities</a></td> <td></td> </tr>

friendica_comments

</td> <td>List of <a href=“help/API-Entities#Item”>Items</a></td> <td></td> </tr>

rights_mismatch

</td> <td>Boolean</td> <td>True if the ACL differs between the picture and the associated item.</td> </tr>

</tbody> </table>

## Photo List Item

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody>

id

</td> <td>String</td> <td>Resource ID (32 hex chars)</td> </tr>

album

</td> <td>String</td> <td>Album name</td> </tr>

filename

</td> <td>String</td> <td>Original image filename</td> </tr>

type

</td> <td>String</td> <td>MIME Type</td> </tr>

created

</td> <td>String (Date)</td> <td>Format

YYYY-MM-DD HH:MM:SS

</td> </tr>

edited

</td> <td>String (Date)</td> <td>Format

YYYY-MM-DD HH:MM:SS

</td> </tr>

desc

</td> <td>String (Plaintext)</td> <td>Picture caption</td> </tr>

thumb

</td> <td>String (URL)</td> <td>URL of the smallest scale version of the picture.</td> </tr>

</tbody> </table>

## Private message

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody>

id

</td> <td>Integer</td> <td></td> </tr>

sender_id

</td> <td>Integer</td> <td>Sender Contact Id</td> </tr>

text

</td> <td>String</td> <td>Can be HTML or plaintext depending on the API call parameter `getText`.</td> </tr>

recipient_id

</td> <td>Integer</td> <td>Recipient Contact Id</td> </tr>

created_at

</td> <td>String (Date)</td> <td>Ex: Wed May 23 06:01:13 +0000 2007</td> </tr>

sender_screen_name

</td> <td>String</td> <td></td> </tr>

recipient_screen_name

</td> <td>String</td> <td></td> </tr>

sender

</td> <td><a href=“help/API-Entities#Contact”>Contact</a></td> <td></td> </tr>

recipient

</td> <td><a href=“help/API-Entities#Contact”>Contact</a></td> <td></td> </tr>

title

</td> <td>String</td> <td>Empty if the API call parameter `getText` is empty or absent.</td> </tr>

friendica_seen

</td> <td>Integer (Boolean)</td> <td>Whether the private message has been read or not.</td> </tr>

friendica_parent_uri

</td> <td>String</td> <td></td> </tr>

</tbody> </table>

## Profile

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody>

profile_id

</td> <td>Integer</td> <td></td> </tr>

profile_name

</td> <td>String</td> <td></td> </tr>

is_default

</td> <td>Boolean</td> <td></td> </tr>

hide_friends

</td> <td>Boolean</td> <td>Whether the user chose to hide their contact list on their profile.</td> </tr>

profile_photo

</td> <td>String (URL)</td> <td>Largest size profile picture URL.</td> </tr>

profile_thumb

</td> <td>String (URL)</td> <td>Smallest size profile picture URL.</td> </tr>

publish

</td> <td>Boolean</td> <td>Whether the user chose to publish their profile in the local directory.</td> </tr>

net_publish

</td> <td>Boolean</td> <td>Whether the user chose to publish their profile in the global directory.</td> </tr>

description

</td> <td>String</td> <td></td> </tr>

date_of_birth

</td> <td>String</td> <td></td> </tr>

address

</td> <td>String</td> <td></td> </tr>

city

</td> <td>String</td> <td></td> </tr>

region

</td> <td>String</td> <td></td> </tr>

postal_code

</td> <td>String</td> <td></td> </tr>

country

</td> <td>String</td> <td></td> </tr>

public_keywords

</td> <td>String</td> <td>Comma-separated list of words meant to be displayed as hashtags.</td> </tr>

private_keywords

</td> <td>String</td> <td>Comma-separated list of words meant to be used for search only.</td> </tr>

homepage

</td> <td>String (URL)</td> <td></td> </tr>

</tbody> </table>

## Size

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody> <table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody>

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

</td> <td>Integer</td> <td align=“center”>No</td> </tr>

resize

</td> <td>Enum (fit, crop)</td> <td align=“center”>Yes</td> </tr>

</tbody> </table>

## Sizes

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody>

medium

</td> <td><a href=“help/API-Entities#Size”>Size</a></td> <td align=“center”>No</td> </tr>

large

</td> <td><a href=“help/API-Entities#Size”>Size</a></td> <td align=“center”>Yes</td> </tr>

thumb

</td> <td><a href=“help/API-Entities#Size”>Size</a></td> <td align=“center”>Yes</td> </tr>

small

</td> <td><a href=“help/API-Entities#Size”>Size</a></td> <td align=“center”>Yes</td> </tr>

</tbody> </table>

## Symbol

Unused

## URL

<table class=“table table-condensed table-striped table-bordered”> <thead> <tr> <th>Attribute</th> <th>Type</th> <th align=“center”>Nullable</th> </tr> </thead> <tbody>

url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

expanded_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

display_url

</td> <td>String (URL)</td> <td align=“center”>No</td> </tr>

indices

</td> <td>List of Integer</td> <td align=“center”>No</td> </tr>

</tbody> </table>

## User Mention

Unused

Friendica / Wiki

The Project

Follow us on ...

(!) This Site need Javascript for some Functions.