nupplaPhil/help
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
help/spec/api/friendica/index.html
Friendica Robot db3e579467 d58f62838e
2022-07-27 21:01:35 +00:00

5418 lines
No EOL
136 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Friendica is a decentralised communications platform that integrates social communication. Our platform links to independent social projects and corporate services.">
<meta name="author" content="The Friendica project">
<link rel="canonical" href="https://friendi.ca/spec/api/friendica/">
<link rel="icon" href="../../../assets/images/friendica-32.png">
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.3.8">
<title>Friendica - Friendica documentation</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.1d29e8d0.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.cbb835fc.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../../assets/stylesheets/friendica.css">
<script>__md_scope=new URL("../../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#friendica-api" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="https://friendi.ca" title="Friendica documentation" class="md-header__button md-logo" aria-label="Friendica documentation" data-md-component="logo">
<img src="../../../assets/images/friendica.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Friendica documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Friendica
</span>
</div>
</div>
</div>
<div class="md-header__option">
<div class="md-select">
<button class="md-header__button md-icon" aria-label="Select language">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12.87 15.07-2.54-2.51.03-.03A17.52 17.52 0 0 0 14.07 6H17V4h-7V2H8v2H1v2h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04M18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12m-2.62 7 1.62-4.33L19.12 17h-3.24Z"/></svg>
</button>
<div class="md-select__inner">
<ul class="md-select__list">
<li class="md-select__item">
<a href="./" hreflang="en" class="md-select__link">
English
</a>
</li>
<li class="md-select__item">
<a href="../../../de/spec/api/friendica/" hreflang="de" class="md-select__link">
Deutsch
</a>
</li>
</ul>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/friendica/friendica" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
friendica/friendica
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-tabs__inner md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../../user/account-basics/" class="md-tabs__link">
User
</a>
</li>
<li class="md-tabs__item">
<a href="../../../admin/install/" class="md-tabs__link">
Admin
</a>
</li>
<li class="md-tabs__item">
<a href="../../../developer/" class="md-tabs__link md-tabs__link--active">
Developer
</a>
</li>
<li class="md-tabs__item">
<a href="../../../bugs-and-issues/" class="md-tabs__link">
Bugs and Issues
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="https://friendi.ca" title="Friendica documentation" class="md-nav__button md-logo" aria-label="Friendica documentation" data-md-component="logo">
<img src="../../../assets/images/friendica.svg" alt="logo">
</a>
Friendica documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/friendica/friendica" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
friendica/friendica
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2">
User
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="User" data-md-level="1">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
User
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_1" type="checkbox" id="__nav_2_1" >
<label class="md-nav__link" for="__nav_2_1">
First Steps
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="First Steps" data-md-level="2">
<label class="md-nav__title" for="__nav_2_1">
<span class="md-nav__icon md-icon"></span>
First Steps
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../user/account-basics/" class="md-nav__link">
Account Basics
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_1_2" type="checkbox" id="__nav_2_1_2" >
<label class="md-nav__link" for="__nav_2_1_2">
Quick Start
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Quick Start" data-md-level="3">
<label class="md-nav__title" for="__nav_2_1_2">
<span class="md-nav__icon md-icon"></span>
Quick Start
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../user/quick-start/guide/" class="md-nav__link">
Start
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/quick-start/network/" class="md-nav__link">
Network
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/quick-start/groups-and-pages/" class="md-nav__link">
Groups & Pages
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/quick-start/making-new-friends/" class="md-nav__link">
Making new friends
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/quick-start/finally/" class="md-nav__link">
Finally
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../user/text-editor/" class="md-nav__link">
Text editor
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/bbcode/" class="md-nav__link">
BBCode
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/text-comment/" class="md-nav__link">
Comments
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/accesskeys/" class="md-nav__link">
Accesskeys
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/events/" class="md-nav__link">
Events
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/keyboard-shortcuts/" class="md-nav__link">
Shortcuts
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" type="checkbox" id="__nav_2_2" >
<label class="md-nav__link" for="__nav_2_2">
You and other users
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="You and other users" data-md-level="2">
<label class="md-nav__title" for="__nav_2_2">
<span class="md-nav__icon md-icon"></span>
You and other users
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../user/connectors/" class="md-nav__link">
Connectors
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/making-friends/" class="md-nav__link">
Making friends
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/groups-and-privacy/" class="md-nav__link">
Groups & Privacy
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/tags-and-mentions/" class="md-nav__link">
Tags & Mentions
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/forums/" class="md-nav__link">
Forums
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/chats/" class="md-nav__link">
Chats
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" type="checkbox" id="__nav_2_3" >
<label class="md-nav__link" for="__nav_2_3">
Further information
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Further information" data-md-level="2">
<label class="md-nav__title" for="__nav_2_3">
<span class="md-nav__icon md-icon"></span>
Further information
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../user/move-account/" class="md-nav__link">
Move account
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/export-import-contacts/" class="md-nav__link">
Import / Export Contacts
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/remove-account/" class="md-nav__link">
Remove account
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/two-factor-authentication/" class="md-nav__link">
2FA
</a>
</li>
<li class="md-nav__item">
<a href="../../../user/faq/" class="md-nav__link">
FAQ
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3">
Admin
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Admin" data-md-level="1">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Admin
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_1" type="checkbox" id="__nav_3_1" >
<label class="md-nav__link" for="__nav_3_1">
Installation
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Installation" data-md-level="2">
<label class="md-nav__title" for="__nav_3_1">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../admin/install/" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="../../../admin/update/" class="md-nav__link">
Update
</a>
</li>
<li class="md-nav__item">
<a href="../../../admin/migrate/" class="md-nav__link">
Migrate
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" type="checkbox" id="__nav_3_2" >
<label class="md-nav__link" for="__nav_3_2">
Configuration
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Configuration" data-md-level="2">
<label class="md-nav__title" for="__nav_3_2">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../admin/settings/" class="md-nav__link">
Settings
</a>
</li>
<li class="md-nav__item">
<a href="../../../admin/config/" class="md-nav__link">
Config Values
</a>
</li>
<li class="md-nav__item">
<a href="../../../admin/ssl/" class="md-nav__link">
SSL
</a>
</li>
<li class="md-nav__item">
<a href="../../../admin/improve-performance/" class="md-nav__link">
Improve Performance
</a>
</li>
<li class="md-nav__item">
<a href="../../../admin/tools/" class="md-nav__link">
Tools
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_3" type="checkbox" id="__nav_3_3" >
<label class="md-nav__link" for="__nav_3_3">
Third Party
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Third Party" data-md-level="2">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Third Party
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../admin/installing-connectors/" class="md-nav__link">
Connectors
</a>
</li>
<li class="md-nav__item">
<a href="../../../admin/install-ejabberd/" class="md-nav__link">
Install ejabberd
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../admin/faq/" class="md-nav__link">
FAQ
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4">
Developer
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Developer" data-md-level="1">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Developer
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../developer/" class="md-nav__link">
Get Started
</a>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_4_2">
Set Up
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Set Up" data-md-level="2">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Set Up
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../developer/github/" class="md-nav__link">
GitHub
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/vagrant/" class="md-nav__link">
Vagrant
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_4_3">
Code structure
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Code structure" data-md-level="2">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Code structure
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../developer/domain-driven-design/" class="md-nav__link">
DDD
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/addons/" class="md-nav__link">
Addons
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/themes/" class="md-nav__link">
Themes
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/smarty3-templates/" class="md-nav__link">
Smarty3
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/addon-storage-backend/" class="md-nav__link">
Addon Storage Backend
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_4" type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_4_4">
How To
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="How To" data-md-level="2">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
How To
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../developer/translations/" class="md-nav__link">
Translations
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/composer/" class="md-nav__link">
Composer
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/how-to-move-classes-to-src/" class="md-nav__link">
src Migration
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/tests/" class="md-nav__link">
Tests
</a>
</li>
<li class="md-nav__item">
<a href="../../../developer/autoloader/" class="md-nav__link">
Autoloader
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_5" type="checkbox" id="__nav_4_5" checked>
<label class="md-nav__link" for="__nav_4_5">
Specification
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Specification" data-md-level="2">
<label class="md-nav__title" for="__nav_4_5">
<span class="md-nav__icon md-icon"></span>
Specification
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_5_1" type="checkbox" id="__nav_4_5_1" checked>
<label class="md-nav__link" for="__nav_4_5_1">
API
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="API" data-md-level="3">
<label class="md-nav__title" for="__nav_4_5_1">
<span class="md-nav__icon md-icon"></span>
API
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
Usage
</a>
</li>
<li class="md-nav__item">
<a href="../entities/" class="md-nav__link">
Entities
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Friendica
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Friendica
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="#entities" class="md-nav__link">
Entities
</a>
</li>
<li class="md-nav__item">
<a href="#endpoints" class="md-nav__link">
Endpoints
</a>
<nav class="md-nav" aria-label="Endpoints">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-apifriendicaevents" class="md-nav__link">
GET api/friendica/events
</a>
<nav class="md-nav" aria-label="GET api/friendica/events">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apiexternalprofileshow" class="md-nav__link">
GET api/externalprofile/show
</a>
<nav class="md-nav" aria-label="GET api/externalprofile/show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_1" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusespublic_timeline" class="md-nav__link">
GET api/statuses/public_timeline
</a>
<nav class="md-nav" aria-label="GET api/statuses/public_timeline">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_2" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusesnetworkpublic_timeline" class="md-nav__link">
GET api/statuses/networkpublic_timeline
</a>
<nav class="md-nav" aria-label="GET api/statuses/networkpublic_timeline">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusesreplies" class="md-nav__link">
GET api/statuses/replies
</a>
<nav class="md-nav" aria-label="GET api/statuses/replies">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_4" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters_1" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apiconversationshow" class="md-nav__link">
GET api/conversation/show
</a>
<nav class="md-nav" aria-label="GET api/conversation/show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_5" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters_2" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusnetconversation" class="md-nav__link">
GET api/statusnet/conversation
</a>
</li>
<li class="md-nav__item">
<a href="#get-apistatusnetconfig" class="md-nav__link">
GET api/statusnet/config
</a>
</li>
<li class="md-nav__item">
<a href="#get-apignusocialconfig" class="md-nav__link">
GET api/gnusocial/config
</a>
</li>
<li class="md-nav__item">
<a href="#get-apistatusnetversion" class="md-nav__link">
GET api/statusnet/version
</a>
</li>
<li class="md-nav__item">
<a href="#get-apignusocialversion" class="md-nav__link">
GET api/gnusocial/version
</a>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaactivityverb" class="md-nav__link">
POST api/friendica/activity/[verb]
</a>
<nav class="md-nav" aria-label="POST api/friendica/activity/[verb]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_6" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messages" class="md-nav__link">
GET api/direct_messages
</a>
<nav class="md-nav" aria-label="GET api/direct_messages">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_7" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters_3" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messagesall" class="md-nav__link">
GET api/direct_messages/all
</a>
<nav class="md-nav" aria-label="GET api/direct_messages/all">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_8" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messagesconversation" class="md-nav__link">
GET api/direct_messages/conversation
</a>
<nav class="md-nav" aria-label="GET api/direct_messages/conversation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_9" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messagessent" class="md-nav__link">
GET api/direct_messages/sent
</a>
<nav class="md-nav" aria-label="GET api/direct_messages/sent">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_10" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apidirect_messagesnew" class="md-nav__link">
POST api/direct_messages/new
</a>
<nav class="md-nav" aria-label="POST api/direct_messages/new">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_11" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apidirect_messagesdestroy" class="md-nav__link">
POST api/direct_messages/destroy
</a>
<nav class="md-nav" aria-label="POST api/direct_messages/destroy">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_12" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_1" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicadirect_messages_setseen" class="md-nav__link">
GET api/friendica/direct_messages_setseen
</a>
<nav class="md-nav" aria-label="GET api/friendica/direct_messages_setseen">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_13" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_2" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicadirect_messages_search-get-auth" class="md-nav__link">
GET api/friendica/direct_messages_search (GET; AUTH)
</a>
<nav class="md-nav" aria-label="GET api/friendica/direct_messages_search (GET; AUTH)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_14" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_3" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicagroup_show" class="md-nav__link">
GET api/friendica/group_show
</a>
<nav class="md-nav" aria-label="GET api/friendica/group_show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_15" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_4" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicagroup_create" class="md-nav__link">
POST api/friendica/group_create
</a>
<nav class="md-nav" aria-label="POST api/friendica/group_create">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_16" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#post-data" class="md-nav__link">
POST data
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_5" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicagroup_update" class="md-nav__link">
POST api/friendica/group_update
</a>
<nav class="md-nav" aria-label="POST api/friendica/group_update">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_17" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#post-data_1" class="md-nav__link">
POST data
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_6" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicagroup_delete" class="md-nav__link">
POST api/friendica/group_delete
</a>
<nav class="md-nav" aria-label="POST api/friendica/group_delete">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_18" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_7" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicanotifications" class="md-nav__link">
GET api/friendica/notifications
</a>
<nav class="md-nav" aria-label="GET api/friendica/notifications">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_19" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicanotificationsseen" class="md-nav__link">
POST api/friendica/notifications/seen
</a>
<nav class="md-nav" aria-label="POST api/friendica/notifications/seen">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_20" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_8" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicaphoto" class="md-nav__link">
GET api/friendica/photo
</a>
<nav class="md-nav" aria-label="GET api/friendica/photo">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_21" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_9" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicaphotoslist" class="md-nav__link">
GET api/friendica/photos/list
</a>
<nav class="md-nav" aria-label="GET api/friendica/photos/list">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return-values_10" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotocreate" class="md-nav__link">
POST api/friendica/photo/create
</a>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotoupdate" class="md-nav__link">
POST api/friendica/photo/update
</a>
<nav class="md-nav" aria-label="POST api/friendica/photo/update">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_22" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_11" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotodelete" class="md-nav__link">
POST api/friendica/photo/delete
</a>
<nav class="md-nav" aria-label="POST api/friendica/photo/delete">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_23" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_12" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotoalbumdelete" class="md-nav__link">
POST api/friendica/photoalbum/delete
</a>
<nav class="md-nav" aria-label="POST api/friendica/photoalbum/delete">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_24" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_13" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotoalbumupdate" class="md-nav__link">
POST api/friendica/photoalbum/update
</a>
<nav class="md-nav" aria-label="POST api/friendica/photoalbum/update">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_25" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_14" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicaprofileshow" class="md-nav__link">
GET api/friendica/profile/show
</a>
<nav class="md-nav" aria-label="GET api/friendica/profile/show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return-values_15" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#deprecated-endpoints" class="md-nav__link">
Deprecated endpoints
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../mastodon/" class="md-nav__link">
Mastodon
</a>
</li>
<li class="md-nav__item">
<a href="../twitter/" class="md-nav__link">
Twitter
</a>
</li>
<li class="md-nav__item">
<a href="../gnu-social/" class="md-nav__link">
GNU Social
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_5_2" type="checkbox" id="__nav_4_5_2" >
<label class="md-nav__link" for="__nav_4_5_2">
Database
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Database" data-md-level="3">
<label class="md-nav__title" for="__nav_4_5_2">
<span class="md-nav__icon md-icon"></span>
Database
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../database/" class="md-nav__link">
Database Tables
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_2fa_app_specific_password/" class="md-nav__link">
2fa_app_specific_password
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_2fa_recovery_codes/" class="md-nav__link">
2fa_recovery_codes
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_2fa_trusted_browser/" class="md-nav__link">
2fa_trusted_browser
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_addon/" class="md-nav__link">
addon
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_apcontact/" class="md-nav__link">
apcontact
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_application/" class="md-nav__link">
application
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_application-marker/" class="md-nav__link">
application-marker
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_application-token/" class="md-nav__link">
application-token
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_attach/" class="md-nav__link">
attach
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_cache/" class="md-nav__link">
cache
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_config/" class="md-nav__link">
config
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_contact/" class="md-nav__link">
contact
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_contact-relation/" class="md-nav__link">
contact-relation
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_conv/" class="md-nav__link">
conv
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_conversation/" class="md-nav__link">
conversation
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_delayed-post/" class="md-nav__link">
delayed-post
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_diaspora-interaction/" class="md-nav__link">
diaspora-interaction
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_endpoint/" class="md-nav__link">
endpoint
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_event/" class="md-nav__link">
event
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_fcontact/" class="md-nav__link">
fcontact
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_fsuggest/" class="md-nav__link">
fsuggest
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_group/" class="md-nav__link">
group
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_group_member/" class="md-nav__link">
group_member
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_gserver/" class="md-nav__link">
gserver
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_gserver-tag/" class="md-nav__link">
gserver-tag
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_hook/" class="md-nav__link">
hook
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_inbox-entry/" class="md-nav__link">
inbox-entry
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_inbox-entry-receiver/" class="md-nav__link">
inbox-entry-receiver
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_inbox-status/" class="md-nav__link">
inbox-status
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_intro/" class="md-nav__link">
intro
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_item-uri/" class="md-nav__link">
item-uri
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_locks/" class="md-nav__link">
locks
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_mail/" class="md-nav__link">
mail
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_mailacct/" class="md-nav__link">
mailacct
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_manage/" class="md-nav__link">
manage
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_notification/" class="md-nav__link">
notification
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_notify/" class="md-nav__link">
notify
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_notify-threads/" class="md-nav__link">
notify-threads
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_oembed/" class="md-nav__link">
oembed
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_openwebauth-token/" class="md-nav__link">
openwebauth-token
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_parsed_url/" class="md-nav__link">
parsed_url
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_pconfig/" class="md-nav__link">
pconfig
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_permissionset/" class="md-nav__link">
permissionset
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_photo/" class="md-nav__link">
photo
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post/" class="md-nav__link">
post
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-category/" class="md-nav__link">
post-category
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-collection/" class="md-nav__link">
post-collection
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-content/" class="md-nav__link">
post-content
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-delivery/" class="md-nav__link">
post-delivery
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-delivery-data/" class="md-nav__link">
post-delivery-data
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-history/" class="md-nav__link">
post-history
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-link/" class="md-nav__link">
post-link
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-media/" class="md-nav__link">
post-media
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-question/" class="md-nav__link">
post-question
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-question-option/" class="md-nav__link">
post-question-option
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-tag/" class="md-nav__link">
post-tag
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-thread/" class="md-nav__link">
post-thread
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-thread-user/" class="md-nav__link">
post-thread-user
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-user/" class="md-nav__link">
post-user
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_post-user-notification/" class="md-nav__link">
post-user-notification
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_process/" class="md-nav__link">
process
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_profile/" class="md-nav__link">
profile
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_profile_field/" class="md-nav__link">
profile_field
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_push_subscriber/" class="md-nav__link">
push_subscriber
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_register/" class="md-nav__link">
register
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_search/" class="md-nav__link">
search
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_session/" class="md-nav__link">
session
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_storage/" class="md-nav__link">
storage
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_subscription/" class="md-nav__link">
subscription
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_tag/" class="md-nav__link">
tag
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_user/" class="md-nav__link">
user
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_user-contact/" class="md-nav__link">
user-contact
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_userd/" class="md-nav__link">
userd
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_verb/" class="md-nav__link">
verb
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_worker-ipc/" class="md-nav__link">
worker-ipc
</a>
</li>
<li class="md-nav__item">
<a href="../../database/db_workerqueue/" class="md-nav__link">
workerqueue
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_5_3" type="checkbox" id="__nav_4_5_3" >
<label class="md-nav__link" for="__nav_4_5_3">
Protocol
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Protocol" data-md-level="3">
<label class="md-nav__title" for="__nav_4_5_3">
<span class="md-nav__icon md-icon"></span>
Protocol
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../protocol/protocol/" class="md-nav__link">
Protocols
</a>
</li>
<li class="md-nav__item">
<a href="../../protocol/message-flow/" class="md-nav__link">
Message Flow
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../bugs-and-issues/" class="md-nav__link">
Bugs and Issues
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="#entities" class="md-nav__link">
Entities
</a>
</li>
<li class="md-nav__item">
<a href="#endpoints" class="md-nav__link">
Endpoints
</a>
<nav class="md-nav" aria-label="Endpoints">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-apifriendicaevents" class="md-nav__link">
GET api/friendica/events
</a>
<nav class="md-nav" aria-label="GET api/friendica/events">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apiexternalprofileshow" class="md-nav__link">
GET api/externalprofile/show
</a>
<nav class="md-nav" aria-label="GET api/externalprofile/show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_1" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusespublic_timeline" class="md-nav__link">
GET api/statuses/public_timeline
</a>
<nav class="md-nav" aria-label="GET api/statuses/public_timeline">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_2" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusesnetworkpublic_timeline" class="md-nav__link">
GET api/statuses/networkpublic_timeline
</a>
<nav class="md-nav" aria-label="GET api/statuses/networkpublic_timeline">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusesreplies" class="md-nav__link">
GET api/statuses/replies
</a>
<nav class="md-nav" aria-label="GET api/statuses/replies">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_4" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters_1" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apiconversationshow" class="md-nav__link">
GET api/conversation/show
</a>
<nav class="md-nav" aria-label="GET api/conversation/show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_5" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters_2" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apistatusnetconversation" class="md-nav__link">
GET api/statusnet/conversation
</a>
</li>
<li class="md-nav__item">
<a href="#get-apistatusnetconfig" class="md-nav__link">
GET api/statusnet/config
</a>
</li>
<li class="md-nav__item">
<a href="#get-apignusocialconfig" class="md-nav__link">
GET api/gnusocial/config
</a>
</li>
<li class="md-nav__item">
<a href="#get-apistatusnetversion" class="md-nav__link">
GET api/statusnet/version
</a>
</li>
<li class="md-nav__item">
<a href="#get-apignusocialversion" class="md-nav__link">
GET api/gnusocial/version
</a>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaactivityverb" class="md-nav__link">
POST api/friendica/activity/[verb]
</a>
<nav class="md-nav" aria-label="POST api/friendica/activity/[verb]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_6" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messages" class="md-nav__link">
GET api/direct_messages
</a>
<nav class="md-nav" aria-label="GET api/direct_messages">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_7" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#unsupported-parameters_3" class="md-nav__link">
Unsupported parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messagesall" class="md-nav__link">
GET api/direct_messages/all
</a>
<nav class="md-nav" aria-label="GET api/direct_messages/all">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_8" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messagesconversation" class="md-nav__link">
GET api/direct_messages/conversation
</a>
<nav class="md-nav" aria-label="GET api/direct_messages/conversation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_9" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apidirect_messagessent" class="md-nav__link">
GET api/direct_messages/sent
</a>
<nav class="md-nav" aria-label="GET api/direct_messages/sent">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_10" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apidirect_messagesnew" class="md-nav__link">
POST api/direct_messages/new
</a>
<nav class="md-nav" aria-label="POST api/direct_messages/new">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_11" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apidirect_messagesdestroy" class="md-nav__link">
POST api/direct_messages/destroy
</a>
<nav class="md-nav" aria-label="POST api/direct_messages/destroy">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_12" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_1" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicadirect_messages_setseen" class="md-nav__link">
GET api/friendica/direct_messages_setseen
</a>
<nav class="md-nav" aria-label="GET api/friendica/direct_messages_setseen">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_13" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_2" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicadirect_messages_search-get-auth" class="md-nav__link">
GET api/friendica/direct_messages_search (GET; AUTH)
</a>
<nav class="md-nav" aria-label="GET api/friendica/direct_messages_search (GET; AUTH)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_14" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_3" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicagroup_show" class="md-nav__link">
GET api/friendica/group_show
</a>
<nav class="md-nav" aria-label="GET api/friendica/group_show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_15" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_4" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicagroup_create" class="md-nav__link">
POST api/friendica/group_create
</a>
<nav class="md-nav" aria-label="POST api/friendica/group_create">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_16" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#post-data" class="md-nav__link">
POST data
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_5" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicagroup_update" class="md-nav__link">
POST api/friendica/group_update
</a>
<nav class="md-nav" aria-label="POST api/friendica/group_update">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_17" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#post-data_1" class="md-nav__link">
POST data
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_6" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicagroup_delete" class="md-nav__link">
POST api/friendica/group_delete
</a>
<nav class="md-nav" aria-label="POST api/friendica/group_delete">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_18" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_7" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicanotifications" class="md-nav__link">
GET api/friendica/notifications
</a>
<nav class="md-nav" aria-label="GET api/friendica/notifications">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_19" class="md-nav__link">
Parameters
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicanotificationsseen" class="md-nav__link">
POST api/friendica/notifications/seen
</a>
<nav class="md-nav" aria-label="POST api/friendica/notifications/seen">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_20" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_8" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicaphoto" class="md-nav__link">
GET api/friendica/photo
</a>
<nav class="md-nav" aria-label="GET api/friendica/photo">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_21" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_9" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicaphotoslist" class="md-nav__link">
GET api/friendica/photos/list
</a>
<nav class="md-nav" aria-label="GET api/friendica/photos/list">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return-values_10" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotocreate" class="md-nav__link">
POST api/friendica/photo/create
</a>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotoupdate" class="md-nav__link">
POST api/friendica/photo/update
</a>
<nav class="md-nav" aria-label="POST api/friendica/photo/update">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_22" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_11" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotodelete" class="md-nav__link">
POST api/friendica/photo/delete
</a>
<nav class="md-nav" aria-label="POST api/friendica/photo/delete">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_23" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_12" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotoalbumdelete" class="md-nav__link">
POST api/friendica/photoalbum/delete
</a>
<nav class="md-nav" aria-label="POST api/friendica/photoalbum/delete">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_24" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_13" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apifriendicaphotoalbumupdate" class="md-nav__link">
POST api/friendica/photoalbum/update
</a>
<nav class="md-nav" aria-label="POST api/friendica/photoalbum/update">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_25" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#return-values_14" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apifriendicaprofileshow" class="md-nav__link">
GET api/friendica/profile/show
</a>
<nav class="md-nav" aria-label="GET api/friendica/profile/show">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return-values_15" class="md-nav__link">
Return values
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#deprecated-endpoints" class="md-nav__link">
Deprecated endpoints
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/friendica/friendica/edit/develop/doc/spec/api/friendica.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
</a>
<nav class="md-tags" >
<span class="md-tag">specification</span>
<span class="md-tag">api</span>
</nav>
<h1 id="friendica-api">Friendica API<a class="headerlink" href="#friendica-api" title="Permanent link">#</a></h1>
<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">#</a></h2>
<p>Friendica provides the following specific endpoints.</p>
<p>Authentication is the same as described in <a href="../#Authentication">Using the APIs</a>.</p>
<h2 id="entities">Entities<a class="headerlink" href="#entities" title="Permanent link">#</a></h2>
<p>These endpoints use the <a href="../entities/">Friendica API entities</a>.</p>
<h2 id="endpoints">Endpoints<a class="headerlink" href="#endpoints" title="Permanent link">#</a></h2>
<h3 id="get-apifriendicaevents">GET api/friendica/events<a class="headerlink" href="#get-apifriendicaevents" title="Permanent link">#</a></h3>
<p>Returns a list of <a href="../entities/#Event">Event</a> entities for the current logged-in user.</p>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<ul>
<li><code>since_id</code>: (optional) minimum event id for pagination</li>
<li><code>count</code>: maximum number of items returned, default 20</li>
</ul>
<h3 id="get-apiexternalprofileshow">GET api/externalprofile/show<a class="headerlink" href="#get-apiexternalprofileshow" title="Permanent link">#</a></h3>
<p>Returns a <a href="../entities/#Contact">Contact</a> entity for the provided profile URL.</p>
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
<ul>
<li><code>profileurl</code>: Profile URL</li>
</ul>
<h3 id="get-apistatusespublic_timeline">GET api/statuses/public_timeline<a class="headerlink" href="#get-apistatusespublic_timeline" title="Permanent link">#</a></h3>
<p>Returns a list of public <a href="../entities/#Item">Items</a> posted on this node.
Equivalent of the local community page.</p>
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
<ul>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>exclude_replies</code>: don't show replies (default: false)</li>
<li><code>conversation_id</code>: Shows all statuses of a given conversation.</li>
<li><code>include_entities</code>: "true" shows entities for pictures and links (Default: false)</li>
</ul>
<h4 id="unsupported-parameters">Unsupported parameters<a class="headerlink" href="#unsupported-parameters" title="Permanent link">#</a></h4>
<ul>
<li><code>trim_user</code></li>
</ul>
<h3 id="get-apistatusesnetworkpublic_timeline">GET api/statuses/networkpublic_timeline<a class="headerlink" href="#get-apistatusesnetworkpublic_timeline" title="Permanent link">#</a></h3>
<p>Returns a list of public <a href="../entities/#Item">Items</a> this node is aware of.
Equivalent of the global community page.</p>
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
<ul>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>exclude_replies</code>: don't show replies (default: false)</li>
<li><code>conversation_id</code>: Shows all statuses of a given conversation.</li>
<li><code>include_entities</code>: "true" shows entities for pictures and links (Default: false)</li>
</ul>
<h3 id="get-apistatusesreplies">GET api/statuses/replies<a class="headerlink" href="#get-apistatusesreplies" title="Permanent link">#</a></h3>
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
<ul>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>include_entities</code>: "true" shows entities for pictures and links (Default: false)</li>
</ul>
<h4 id="unsupported-parameters_1">Unsupported parameters<a class="headerlink" href="#unsupported-parameters_1" title="Permanent link">#</a></h4>
<ul>
<li><code>include_rts</code></li>
<li><code>trim_user</code></li>
<li><code>contributor_details</code></li>
</ul>
<hr />
<h3 id="get-apiconversationshow">GET api/conversation/show<a class="headerlink" href="#get-apiconversationshow" title="Permanent link">#</a></h3>
<p>Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.</p>
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
<ul>
<li><code>id</code>: id of the post</li>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>include_entities</code>: "true" shows entities for pictures and links (Default: false)</li>
</ul>
<h4 id="unsupported-parameters_2">Unsupported parameters<a class="headerlink" href="#unsupported-parameters_2" title="Permanent link">#</a></h4>
<ul>
<li><code>include_rts</code></li>
<li><code>trim_user</code></li>
<li><code>contributor_details</code></li>
</ul>
<h3 id="get-apistatusnetconversation">GET api/statusnet/conversation<a class="headerlink" href="#get-apistatusnetconversation" title="Permanent link">#</a></h3>
<p>Alias of <a href="#GET+api%2Fconversation%2Fshow"><code>api/conversation/show</code></a>.</p>
<h3 id="get-apistatusnetconfig">GET api/statusnet/config<a class="headerlink" href="#get-apistatusnetconfig" title="Permanent link">#</a></h3>
<p>Returns the public Friendica node configuration. </p>
<h3 id="get-apignusocialconfig">GET api/gnusocial/config<a class="headerlink" href="#get-apignusocialconfig" title="Permanent link">#</a></h3>
<p>Alias of <a href="#GET+api%2Fstatusnet%2Fconfig"><code>api/statusnet/config</code></a>.</p>
<h3 id="get-apistatusnetversion">GET api/statusnet/version<a class="headerlink" href="#get-apistatusnetversion" title="Permanent link">#</a></h3>
<p>Returns a fake static StatusNet protocol version.</p>
<h3 id="get-apignusocialversion">GET api/gnusocial/version<a class="headerlink" href="#get-apignusocialversion" title="Permanent link">#</a></h3>
<p>Alias of <a href="#GET+api%2Fstatusnet%2Fversion"><code>api/statusnet/version</code></a>.</p>
<hr />
<h3 id="post-apifriendicaactivityverb">POST api/friendica/activity/[verb]<a class="headerlink" href="#post-apifriendicaactivityverb" title="Permanent link">#</a></h3>
<p>Add or remove an activity from an item.
'verb' can be one of:</p>
<ul>
<li><code>like</code></li>
<li><code>dislike</code></li>
<li><code>attendyes</code></li>
<li><code>attendno</code></li>
<li><code>attendmaybe</code></li>
</ul>
<p>To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
Attend verbs should be used only with event-related items (there is no check at the moment).</p>
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
<ul>
<li><code>id</code>: item id</li>
</ul>
<h4 id="return-values">Return values<a class="headerlink" href="#return-values" title="Permanent link">#</a></h4>
<p>On success:
json:</p>
<p><code>"ok"</code></p>
<p>xml:</p>
<p><code>&lt;ok&gt;true&lt;/ok&gt;</code></p>
<p>On error:
HTTP 400 BadRequest</p>
<hr />
<h3 id="get-apidirect_messages">GET api/direct_messages<a class="headerlink" href="#get-apidirect_messages" title="Permanent link">#</a></h3>
<p>Deprecated Twitter received direct message list endpoint.</p>
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
<ul>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>getText</code>: Defines the format of the status field. Can be "html" or "plain"</li>
<li><code>include_entities</code>: "true" shows entities for pictures and links (Default: false)</li>
<li><code>friendica_verbose</code>: "true" enables different error returns (default: "false")</li>
</ul>
<h4 id="unsupported-parameters_3">Unsupported parameters<a class="headerlink" href="#unsupported-parameters_3" title="Permanent link">#</a></h4>
<ul>
<li><code>skip_status</code></li>
</ul>
<h3 id="get-apidirect_messagesall">GET api/direct_messages/all<a class="headerlink" href="#get-apidirect_messagesall" title="Permanent link">#</a></h3>
<p>Returns all <a href="../entities/#private-message">Private Messages</a>.</p>
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
<ul>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>getText</code>: Defines the format of the status field. Can be "html" or "plain"</li>
<li><code>friendica_verbose</code>: "true" enables different error returns (default: "false")</li>
</ul>
<h3 id="get-apidirect_messagesconversation">GET api/direct_messages/conversation<a class="headerlink" href="#get-apidirect_messagesconversation" title="Permanent link">#</a></h3>
<p>Returns all replies of a single private message conversation. Returns <a href="../entities/#private-message">Private Messages</a></p>
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
<ul>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>getText</code>: Defines the format of the status field. Can be "html" or "plain"</li>
<li><code>uri</code>: URI of the conversation</li>
<li><code>friendica_verbose</code>: "true" enables different error returns (default: "false")</li>
</ul>
<h3 id="get-apidirect_messagessent">GET api/direct_messages/sent<a class="headerlink" href="#get-apidirect_messagessent" title="Permanent link">#</a></h3>
<p>Deprecated Twitter sent direct message list endpoint. Returns <a href="../entities/#private-message">Private Messages</a>.</p>
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
<ul>
<li><code>count</code>: Items per page (default: 20)</li>
<li><code>page</code>: page number</li>
<li><code>since_id</code>: minimum id</li>
<li><code>max_id</code>: maximum id</li>
<li><code>getText</code>: Defines the format of the status field. Can be "html" or "plain"</li>
<li><code>include_entities</code>: "true" shows entities for pictures and links (Default: false)</li>
<li><code>friendica_verbose</code>: "true" enables different error returns (default: "false")</li>
</ul>
<h3 id="post-apidirect_messagesnew">POST api/direct_messages/new<a class="headerlink" href="#post-apidirect_messagesnew" title="Permanent link">#</a></h3>
<p>Deprecated Twitter direct message submission endpoint.</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
<ul>
<li><code>user_id</code>: id of the user</li>
<li><code>screen_name</code>: screen name (for technical reasons, this value is not unique!)</li>
<li><code>text</code>: The message</li>
<li><code>replyto</code>: ID of the replied direct message</li>
<li><code>title</code>: Title of the direct message</li>
</ul>
<h3 id="post-apidirect_messagesdestroy">POST api/direct_messages/destroy<a class="headerlink" href="#post-apidirect_messagesdestroy" title="Permanent link">#</a></h3>
<p>Deprecated Twitter direct message deletion endpoint.</p>
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
<ul>
<li><code>id</code>: id of the message to be deleted</li>
<li><code>include_entities</code>: optional, currently not yet implemented</li>
<li><code>friendica_parenturi</code>: optional, can be used for increased safety to delete only intended messages</li>
<li><code>friendica_verbose</code>: "true" enables different error returns (default: "false")</li>
</ul>
<h4 id="return-values_1">Return values<a class="headerlink" href="#return-values_1" title="Permanent link">#</a></h4>
<p>On success:</p>
<ul>
<li>JSON return as defined for Twitter API not yet implemented</li>
<li>on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}</li>
</ul>
<p>On error:
HTTP 400 BadRequest</p>
<ul>
<li>on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}</li>
</ul>
<h3 id="get-apifriendicadirect_messages_setseen">GET api/friendica/direct_messages_setseen<a class="headerlink" href="#get-apifriendicadirect_messages_setseen" title="Permanent link">#</a></h3>
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
<ul>
<li><code>id</code>: id of the message to be updated as seen</li>
</ul>
<h4 id="return-values_2">Return values<a class="headerlink" href="#return-values_2" title="Permanent link">#</a></h4>
<p>On success:</p>
<ul>
<li>JSON return <code>{"result": "ok", "message": "message set to seen"}</code></li>
</ul>
<p>On error:</p>
<ul>
<li>different JSON returns <code>{"result": "error", "message": "xyz"}</code></li>
</ul>
<h3 id="get-apifriendicadirect_messages_search-get-auth">GET api/friendica/direct_messages_search (GET; AUTH)<a class="headerlink" href="#get-apifriendicadirect_messages_search-get-auth" title="Permanent link">#</a></h3>
<p>Returns <a href="../entities/#Private+message">Private Messages</a> matching the provided search string.</p>
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
<ul>
<li><code>searchstring</code>: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)</li>
<li><code>getText</code> (optional): <code>plain</code>|<code>html</code> If ommited, the title is prepended to the plaintext body in the <code>text</code> attribute of the private message objects.</li>
<li><code>getUserObjects</code> (optional): <code>true</code>|<code>false</code> If <code>false</code>, the <code>sender</code> and <code>recipient</code> attributes of the private message object are absent.</li>
</ul>
<h4 id="return-values_3">Return values<a class="headerlink" href="#return-values_3" title="Permanent link">#</a></h4>
<p>Returns only tested with JSON, XML might work as well.</p>
<p>On success:</p>
<ul>
<li>JSON return <code>{"success":"true", "search_results": array of found messages}</code></li>
<li>JSOn return <code>{"success":"false", "search_results": "nothing found"}</code></li>
</ul>
<p>On error:</p>
<ul>
<li>different JSON returns <code>{"result": "error", "message": "searchstring not specified"}</code></li>
</ul>
<hr />
<h3 id="get-apifriendicagroup_show">GET api/friendica/group_show<a class="headerlink" href="#get-apifriendicagroup_show" title="Permanent link">#</a></h3>
<p>Return all or a specified group of the user with the containing contacts as array.</p>
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
<ul>
<li><code>gid</code>: optional, if not given, API returns all groups of the user</li>
</ul>
<h4 id="return-values_4">Return values<a class="headerlink" href="#return-values_4" title="Permanent link">#</a></h4>
<p>Array of:</p>
<ul>
<li><code>name</code>: name of the group</li>
<li><code>gid</code>: id of the group</li>
<li><code>user</code>: array of <a href="../entities/#contact">Contacts</a></li>
</ul>
<h3 id="post-apifriendicagroup_create">POST api/friendica/group_create<a class="headerlink" href="#post-apifriendicagroup_create" title="Permanent link">#</a></h3>
<p>Create the group with the posted array of contacts as members.</p>
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
<ul>
<li><code>name</code>: name of the group to be created</li>
</ul>
<h4 id="post-data">POST data<a class="headerlink" href="#post-data" title="Permanent link">#</a></h4>
<p>JSON data as Array like the result of <a href="#GET+api%2Ffriendica%2Fgroup_show">GET api/friendica/group_show</a>:</p>
<ul>
<li><code>gid</code></li>
<li><code>name</code></li>
<li>List of <a href="../entities/#contact">Contacts</a></li>
</ul>
<h4 id="return-values_5">Return values<a class="headerlink" href="#return-values_5" title="Permanent link">#</a></h4>
<p>Array of:</p>
<ul>
<li><code>success</code>: true if successfully created or reactivated</li>
<li><code>gid</code>: gid of the created group</li>
<li><code>name</code>: name of the created group</li>
<li><code>status</code>: "missing user" | "reactivated" | "ok"</li>
<li><code>wrong users</code>: array of users, which were not available in the contact table</li>
</ul>
<h3 id="post-apifriendicagroup_update">POST api/friendica/group_update<a class="headerlink" href="#post-apifriendicagroup_update" title="Permanent link">#</a></h3>
<p>Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).</p>
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
<ul>
<li><code>gid</code>: id of the group to be changed</li>
<li><code>name</code>: name of the group to be changed</li>
</ul>
<h4 id="post-data_1">POST data<a class="headerlink" href="#post-data_1" title="Permanent link">#</a></h4>
<p>JSON data as array like the result of <a href="#GET+api%2Ffriendica%2Fgroup_show">GET api/friendica/group_show</a>:</p>
<ul>
<li><code>gid</code></li>
<li><code>name</code></li>
<li>List of <a href="../entities/#contact">Contacts</a></li>
</ul>
<h4 id="return-values_6">Return values<a class="headerlink" href="#return-values_6" title="Permanent link">#</a></h4>
<p>Array of:</p>
<ul>
<li><code>success</code>: true if successfully updated</li>
<li><code>gid</code>: gid of the changed group</li>
<li><code>name</code>: name of the changed group</li>
<li><code>status</code>: "missing user" | "ok"</li>
<li><code>wrong users</code>: array of users, which were not available in the contact table</li>
</ul>
<h3 id="post-apifriendicagroup_delete">POST api/friendica/group_delete<a class="headerlink" href="#post-apifriendicagroup_delete" title="Permanent link">#</a></h3>
<p>Delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.</p>
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
<ul>
<li><code>gid</code>: id of the group to be deleted</li>
<li><code>name</code>: name of the group to be deleted</li>
</ul>
<h4 id="return-values_7">Return values<a class="headerlink" href="#return-values_7" title="Permanent link">#</a></h4>
<p>Array of:</p>
<ul>
<li><code>success</code>: true if successfully deleted</li>
<li><code>gid</code>: gid of the deleted group</li>
<li><code>name</code>: name of the deleted group</li>
<li><code>status</code>: "deleted" if successfully deleted</li>
<li><code>wrong users</code>: empty array</li>
</ul>
<hr />
<h3 id="get-apifriendicanotifications">GET api/friendica/notifications<a class="headerlink" href="#get-apifriendicanotifications" title="Permanent link">#</a></h3>
<p>Return last 50 <a href="../entities/#notification">Notifications</a> for the current user, ordered by date with unseen item on top.</p>
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
<p>none</p>
<h3 id="post-apifriendicanotificationsseen">POST api/friendica/notifications/seen<a class="headerlink" href="#post-apifriendicanotificationsseen" title="Permanent link">#</a></h3>
<p>Set notification as seen.</p>
<h4 id="parameters_20">Parameters<a class="headerlink" href="#parameters_20" title="Permanent link">#</a></h4>
<ul>
<li><code>id</code>: id of the notification to set seen</li>
</ul>
<h4 id="return-values_8">Return values<a class="headerlink" href="#return-values_8" title="Permanent link">#</a></h4>
<p>If the note is linked to an item, returns an <a href="../entities/#item">Item</a>.</p>
<p>Otherwise, a success status is returned:</p>
<ul>
<li><code>success</code> (json) | <code>&lt;status&gt;success&lt;/status&gt;</code> (xml)</li>
</ul>
<hr />
<h3 id="get-apifriendicaphoto">GET api/friendica/photo<a class="headerlink" href="#get-apifriendicaphoto" title="Permanent link">#</a></h3>
<p>Returns a <a href="../entities/#photo">Photo</a>.</p>
<h4 id="parameters_21">Parameters<a class="headerlink" href="#parameters_21" title="Permanent link">#</a></h4>
<ul>
<li><code>photo_id</code>: Resource id of a photo.</li>
<li><code>scale</code>: (optional) scale value of the photo</li>
</ul>
<p>Returns data of a picture with the given resource.
If 'scale' isn't provided, returned data include full url to each scale of the photo.
If 'scale' is set, returned data include image data base64 encoded.</p>
<p>possibile scale value are:</p>
<ul>
<li>0: original or max size by server settings</li>
<li>1: image with or height at &lt;= 640</li>
<li>2: image with or height at &lt;= 320</li>
<li>3: thumbnail 160x160</li>
<li>4: Profile image at 300x300</li>
<li>5: Profile image at 80x80</li>
<li>6: Profile image at 48x48</li>
</ul>
<p>An image used as profile image has only scaled 4-6, other images only 0-3</p>
<h4 id="return-values_9">Return values<a class="headerlink" href="#return-values_9" title="Permanent link">#</a></h4>
<p>json:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="w"> </span><span class="p">{</span><span class="w"></span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;photo id&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">&quot;created&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;date(YYYY-MM-DD HH:MM:SS)&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">&quot;edited&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;date(YYYY-MM-DD HH:MM:SS)&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;photo title&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="nt">&quot;desc&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;photo description&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="nt">&quot;album&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;album name&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="nt">&quot;filename&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;original file name&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mime type&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="nt">&quot;height&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;number&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w"> </span><span class="nt">&quot;width&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;number&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w"> </span><span class="nt">&quot;profile&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1 if is profile photo&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w"> </span><span class="nt">&quot;link&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="w"> </span><span class="nt">&quot;&lt;scale&gt;&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;url to image&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="w"> </span><span class="err">...</span><span class="w"></span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="w"> </span><span class="p">},</span><span class="w"></span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w"> </span><span class="c1">// if &#39;scale&#39; is set</span><span class="w"></span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="w"> </span><span class="nt">&quot;datasize&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;size in byte&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;base64 encoded image data&quot;</span><span class="w"></span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="w"> </span><span class="p">}</span><span class="w"></span>
</code></pre></div>
<p>xml:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a> <span class="nt">&lt;photo&gt;</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a> <span class="nt">&lt;id&gt;</span>photo id<span class="nt">&lt;/id&gt;</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a> <span class="nt">&lt;created&gt;</span>date(YYYY-MM-DD HH:MM:SS)<span class="nt">&lt;/created&gt;</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a> <span class="nt">&lt;edited&gt;</span>date(YYYY-MM-DD HH:MM:SS)<span class="nt">&lt;/edited&gt;</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a> <span class="nt">&lt;title&gt;</span>photo title<span class="nt">&lt;/title&gt;</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a> <span class="nt">&lt;desc&gt;</span>photo description<span class="nt">&lt;/desc&gt;</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a> <span class="nt">&lt;album&gt;</span>album name<span class="nt">&lt;/album&gt;</span>
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a> <span class="nt">&lt;filename&gt;</span>original file name<span class="nt">&lt;/filename&gt;</span>
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a> <span class="nt">&lt;type&gt;</span>mime type<span class="nt">&lt;/type&gt;</span>
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a> <span class="nt">&lt;height&gt;</span>number<span class="nt">&lt;/height&gt;</span>
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a> <span class="nt">&lt;width&gt;</span>number<span class="nt">&lt;/width&gt;</span>
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a> <span class="nt">&lt;profile&gt;</span>1 if is profile photo<span class="nt">&lt;/profile&gt;</span>
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a> <span class="nt">&lt;links</span> <span class="na">type=</span><span class="s">&quot;array&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a> <span class="nt">&lt;link</span> <span class="na">type=</span><span class="s">&quot;mime type&quot;</span> <span class="na">scale=</span><span class="s">&quot;scale number&quot;</span> <span class="na">href=</span><span class="s">&quot;image url&quot;</span><span class="nt">/&gt;</span>
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a> ...
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a> <span class="nt">&lt;/links&gt;</span>
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a> <span class="nt">&lt;/photo&gt;</span>
</code></pre></div>
<h3 id="get-apifriendicaphotoslist">GET api/friendica/photos/list<a class="headerlink" href="#get-apifriendicaphotoslist" title="Permanent link">#</a></h3>
<p>Returns the API user's <a href="../entities/#photo-list-item">Photo List Items</a>.</p>
<h4 id="return-values_10">Return values<a class="headerlink" href="#return-values_10" title="Permanent link">#</a></h4>
<p>json:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="w"> </span><span class="p">[</span><span class="w"></span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="p">{</span><span class="w"></span>
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;resource_id&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nt">&quot;album&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;album name&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="nt">&quot;filename&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;original file name&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;image mime type&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="nt">&quot;thumb&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;url to thumb sized image&quot;</span><span class="w"></span>
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="w"> </span><span class="p">},</span><span class="w"></span>
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w"> </span><span class="err">...</span><span class="w"></span>
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w"> </span><span class="p">]</span><span class="w"></span>
</code></pre></div>
<p>xml:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a> <span class="nt">&lt;photos</span> <span class="na">type=</span><span class="s">&quot;array&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> <span class="nt">&lt;photo</span> <span class="na">id=</span><span class="s">&quot;resource_id&quot;</span>
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> <span class="na">album=</span><span class="s">&quot;album name&quot;</span>
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> <span class="na">filename=</span><span class="s">&quot;original file name&quot;</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a> <span class="na">type=</span><span class="s">&quot;image mime type&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a> &quot;url to thumb sized image&quot;
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a> <span class="nt">&lt;/photo&gt;</span>
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a> ...
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a> <span class="nt">&lt;/photos&gt;</span>
</code></pre></div>
<h3 id="post-apifriendicaphotocreate">POST api/friendica/photo/create<a class="headerlink" href="#post-apifriendicaphotocreate" title="Permanent link">#</a></h3>
<p>Alias of <a href="#POST+api%2Ffriendica%2Fphoto%2Fupdate"><code>api/friendica/photo/update</code></a></p>
<h3 id="post-apifriendicaphotoupdate">POST api/friendica/photo/update<a class="headerlink" href="#post-apifriendicaphotoupdate" title="Permanent link">#</a></h3>
<p>Saves data for the scales 0-2 to database (see above for scale description).
Call adds non-public entries to items table to enable authenticated contacts to comment/like the photo.
Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group.
Currently, it is best to inform user that updating rights is not the right way to do this, and offer a solution to add photo as a new photo with the new rights instead.</p>
<h4 id="parameters_22">Parameters<a class="headerlink" href="#parameters_22" title="Permanent link">#</a></h4>
<ul>
<li><code>photo_id</code> (optional): if specified the photo with this id will be updated</li>
<li><code>media</code> (optional): image data as base64, only optional if photo_id is specified (new upload must have media)</li>
<li><code>desc</code> (optional): description for the photo, updated when photo_id is specified</li>
<li><code>album</code>: name of the album to be deleted (always necessary)</li>
<li><code>album_new</code> (optional): can be used to change the album of a single photo if photo_id is specified</li>
<li><code>allow_cid</code>/<code>allow_gid</code>/<code>deny_cid</code>/<code>deny_gid</code> (optional):<ul>
<li>on create: empty string or omitting = public photo, specify in format <code>&lt;x&gt;&lt;y&gt;&lt;z&gt;</code>for private photo</li>
<li>on update: keys need to be present with empty values for changing a private photo to public</li>
</ul>
</li>
</ul>
<h4 id="return-values_11">Return values<a class="headerlink" href="#return-values_11" title="Permanent link">#</a></h4>
<p>On success:</p>
<ul>
<li>new photo uploaded: JSON return with photo data (see <a href="#GET+api%2Ffriendica%2Fphoto">GET api/friendica/photo</a>)</li>
<li>photo updated - changed photo data: JSON return with photo data (see <a href="#GET+api%2Ffriendica%2Fphoto">GET api/friendica/photo</a>)</li>
<li>photo updated - changed info: JSON return <code>{"result": "updated", "message":"Image id 'xyz' has been updated."}</code></li>
<li>photo updated - nothing changed: JSON return <code>{"result": "cancelled","message": "Nothing to update for image id 'xyz'."}</code></li>
</ul>
<p>On error:</p>
<ul>
<li>403 FORBIDDEN: if not authenticated</li>
<li>400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"</li>
<li>500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
"image size exceeds Friendica Config setting (uploaded size: x)",
"unable to process image data",
"image upload failed",
"unknown error - uploading photo failed, see Friendica log for more information",
"unknown error - update photo entry in database failed",
"unknown error - this error on uploading or updating a photo should never happen"</li>
</ul>
<h3 id="post-apifriendicaphotodelete">POST api/friendica/photo/delete<a class="headerlink" href="#post-apifriendicaphotodelete" title="Permanent link">#</a></h3>
<p>Deletes a single image with the specified id, is not reversible -&gt; ensure that client is asking user for being sure to do this
Sets item table entries for this photo to deleted = 1.</p>
<h4 id="parameters_23">Parameters<a class="headerlink" href="#parameters_23" title="Permanent link">#</a></h4>
<ul>
<li><code>photo_id</code>: id of the photo to be deleted</li>
</ul>
<h4 id="return-values_12">Return values<a class="headerlink" href="#return-values_12" title="Permanent link">#</a></h4>
<p>On success:</p>
<ul>
<li>JSON return </li>
</ul>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="p">{</span><span class="w"></span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">&quot;result&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;deleted&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;photo with id &#39;xyz&#39; has been deleted from server.&quot;</span><span class="w"></span>
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="p">}</span><span class="w"></span>
</code></pre></div>
<p>On error:</p>
<ul>
<li>403 FORBIDDEN: if not authenticated</li>
<li>400 BADREQUEST: "no photo_id specified", "photo not available"</li>
<li>500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"</li>
</ul>
<hr />
<h3 id="post-apifriendicaphotoalbumdelete">POST api/friendica/photoalbum/delete<a class="headerlink" href="#post-apifriendicaphotoalbumdelete" title="Permanent link">#</a></h3>
<p>Deletes all images with the specified album name, is not reversible -&gt; ensure that client is asking user for being sure to do this.</p>
<h4 id="parameters_24">Parameters<a class="headerlink" href="#parameters_24" title="Permanent link">#</a></h4>
<ul>
<li><code>album</code>: name of the album to be deleted</li>
</ul>
<h4 id="return-values_13">Return values<a class="headerlink" href="#return-values_13" title="Permanent link">#</a></h4>
<p>On success:</p>
<ul>
<li>JSON return </li>
</ul>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">{</span><span class="w"></span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">&quot;result&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;deleted&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;album &#39;xyz&#39; with all containing photos has been deleted.&quot;</span><span class="w"></span>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="p">}</span><span class="w"></span>
</code></pre></div>
<p>On error:</p>
<ul>
<li>403 FORBIDDEN: if not authenticated</li>
<li>400 BADREQUEST: "no albumname specified", "album not available"</li>
<li>500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"</li>
</ul>
<h3 id="post-apifriendicaphotoalbumupdate">POST api/friendica/photoalbum/update<a class="headerlink" href="#post-apifriendicaphotoalbumupdate" title="Permanent link">#</a></h3>
<p>Changes the album name to album_new for all photos in album.</p>
<h4 id="parameters_25">Parameters<a class="headerlink" href="#parameters_25" title="Permanent link">#</a></h4>
<ul>
<li><code>album</code>: name of the album to be updated</li>
<li><code>album_new</code>: new name of the album</li>
</ul>
<h4 id="return-values_14">Return values<a class="headerlink" href="#return-values_14" title="Permanent link">#</a></h4>
<p>On success:</p>
<ul>
<li>JSON return</li>
</ul>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="p">{</span><span class="w"></span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="nt">&quot;result&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;updated&quot;</span><span class="p">,</span><span class="w"></span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="s2">&quot;album &#39;abc&#39; with all containing photos has been renamed to &#39;xyz&#39;.&quot;</span><span class="w"></span>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="p">}</span><span class="w"></span>
</code></pre></div>
<p>On error:</p>
<ul>
<li>403 FORBIDDEN: if not authenticated</li>
<li>400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"</li>
<li>500 INTERNALSERVERERROR: "unknown error - updating in database failed"</li>
</ul>
<hr />
<h3 id="get-apifriendicaprofileshow">GET api/friendica/profile/show<a class="headerlink" href="#get-apifriendicaprofileshow" title="Permanent link">#</a></h3>
<p>Returns the <a href="../entities/#profile">Profile</a> data of the authenticated user.</p>
<h4 id="return-values_15">Return values<a class="headerlink" href="#return-values_15" title="Permanent link">#</a></h4>
<p>On success: Array of:</p>
<ul>
<li><code>global_dir</code>: URL of the global directory set in server settings</li>
<li><code>friendica_owner</code>: user data of the authenticated user</li>
<li><code>profiles</code>: array of the profile data</li>
</ul>
<p>On error:
HTTP 403 Forbidden: when no authentication was provided
HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user</p>
<p>General description of profile data in API returns:
- hide_friends: true if friends are hidden
- profile_photo
- profile_thumb
- publish: true if published on the server's local directory
- net_publish: true if published to global_dir
- fullname
- date_of_birth
- description
- xmpp
- homepage
- address
- locality
- region
- postal_code
- country
- pub_keywords
- custom_fields: list of public custom fields</p>
<hr />
<h2 id="deprecated-endpoints">Deprecated endpoints<a class="headerlink" href="#deprecated-endpoints" title="Permanent link">#</a></h2>
<ul>
<li>POST api/statuses/mediap</li>
</ul>
</article>
</div>
</div>
<a href="#" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>
Back to top
</a>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../entities/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Entities" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
Entities
</div>
</div>
</a>
<a href="../mastodon/" class="md-footer__link md-footer__link--next" aria-label="Next: Mastodon" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Mastodon
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2010-2022, the Friendica project
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.annotate", "content.tooltips", "navigation.indexes", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../../assets/javascripts/workers/search.b97dbffb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
<script src="../../../assets/javascripts/bundle.0238f547.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink