https://cookifed.dev/docs/api/v1/account/ Recent content in Account on Cookifed Hugo en-US https://cookifed.dev/docs/api/v1/account/get-blocks/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/get-blocks/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">GET /api/v1/blocks</span></span></code></pre></div> </figure> </div> <p>Returns accounts blocked by the authenticated user. A blocked account cannot interact with or appear in the user&rsquo;s timeline and notifications.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:read</code></li> </ul> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="200">200</h3> <p>blocked accounts</p> <p><strong>Schema:</strong> array[<code>account_output</code>]</p> <h4 id="account_output"><code>account_output</code></h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>username</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>name</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary_html</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>instance</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>avatar</code></td> <td>object</td> <td>yes</td> <td></td> </tr> <tr> <td><code>state</code></td> <td>string</td> <td>yes</td> <td>The account&rsquo;s current sync status. - <code>unknown</code>: We don&rsquo;t know anything about this account. It may not even exist. - <code>loading</code>: We have loaded this account&rsquo;s direct information, and are currently loading the statuses. - <code>loaded</code>: We have loaded the data from this account. Note that this doesn&rsquo;t mean we actually have 100% of the data. There could be new data we haven&rsquo;t loaded yet, or that wasn&rsquo;t delivered to us. Local and managed accounts always have a state of <code>loaded</code>.</td> </tr> <tr> <td><code>following_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>followers_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>like_id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> </tbody> </table> https://cookifed.dev/docs/api/v1/account/post-accounts-account_id-block/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/post-accounts-account_id-block/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">POST /api/v1/accounts/{account_id}/block</span></span></code></pre></div> </figure> </div> <p>Block the specified account, preventing it from interacting with or appearing in the authenticated user&rsquo;s timeline and notifications.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:write</code></li> </ul> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>account_id</code></td> <td>path</td> <td>yes</td> <td>integer</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="201">201</h3> <p>block</p> https://cookifed.dev/docs/api/v1/account/delete-accounts-account_id-block/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/delete-accounts-account_id-block/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">DELETE /api/v1/accounts/{account_id}/block</span></span></code></pre></div> </figure> </div> <p>Remove an existing block on the specified account, restoring its ability to interact with and appear in the authenticated user&rsquo;s feed.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:write</code></li> </ul> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>account_id</code></td> <td>path</td> <td>yes</td> <td>integer</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="204">204</h3> <p>unblock</p> https://cookifed.dev/docs/api/v1/account/get-accounts-account_id-followers/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/get-accounts-account_id-followers/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">GET /api/v1/accounts/{account_id}/followers</span></span></code></pre></div> </figure> </div> <p>Returns accounts that follow the specified account, ordered by follow date. Works for both local and federated remote accounts.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:read</code></li> </ul> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>account_id</code></td> <td>path</td> <td>yes</td> <td>integer</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="200">200</h3> <p>followers</p> <p><strong>Schema:</strong> array[<code>account_output</code>]</p> <h4 id="account_output"><code>account_output</code></h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>username</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>name</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary_html</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>instance</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>avatar</code></td> <td>object</td> <td>yes</td> <td></td> </tr> <tr> <td><code>state</code></td> <td>string</td> <td>yes</td> <td>The account&rsquo;s current sync status. - <code>unknown</code>: We don&rsquo;t know anything about this account. It may not even exist. - <code>loading</code>: We have loaded this account&rsquo;s direct information, and are currently loading the statuses. - <code>loaded</code>: We have loaded the data from this account. Note that this doesn&rsquo;t mean we actually have 100% of the data. There could be new data we haven&rsquo;t loaded yet, or that wasn&rsquo;t delivered to us. Local and managed accounts always have a state of <code>loaded</code>.</td> </tr> <tr> <td><code>following_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>followers_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>like_id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> </tbody> </table> https://cookifed.dev/docs/api/v1/account/get-accounts-account_id-following/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/get-accounts-account_id-following/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">GET /api/v1/accounts/{account_id}/following</span></span></code></pre></div> </figure> </div> <p>Returns accounts that the specified account is following, ordered by follow date. Works for both local and federated remote accounts.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:read</code></li> </ul> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>account_id</code></td> <td>path</td> <td>yes</td> <td>integer</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="200">200</h3> <p>following</p> <p><strong>Schema:</strong> array[<code>account_output</code>]</p> <h4 id="account_output"><code>account_output</code></h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>username</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>name</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary_html</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>instance</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>avatar</code></td> <td>object</td> <td>yes</td> <td></td> </tr> <tr> <td><code>state</code></td> <td>string</td> <td>yes</td> <td>The account&rsquo;s current sync status. - <code>unknown</code>: We don&rsquo;t know anything about this account. It may not even exist. - <code>loading</code>: We have loaded this account&rsquo;s direct information, and are currently loading the statuses. - <code>loaded</code>: We have loaded the data from this account. Note that this doesn&rsquo;t mean we actually have 100% of the data. There could be new data we haven&rsquo;t loaded yet, or that wasn&rsquo;t delivered to us. Local and managed accounts always have a state of <code>loaded</code>.</td> </tr> <tr> <td><code>following_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>followers_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>like_id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> </tbody> </table> https://cookifed.dev/docs/api/v1/account/post-accounts-account_id-follow/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/post-accounts-account_id-follow/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">POST /api/v1/accounts/{account_id}/follow</span></span></code></pre></div> </figure> </div> <p>Create a follow relationship between the authenticated user and the specified account. Federation is handled automatically for remote accounts.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:write</code></li> </ul> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>account_id</code></td> <td>path</td> <td>yes</td> <td>integer</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="201">201</h3> <p>follow</p> https://cookifed.dev/docs/api/v1/account/delete-accounts-account_id-follow/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/delete-accounts-account_id-follow/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">DELETE /api/v1/accounts/{account_id}/follow</span></span></code></pre></div> </figure> </div> <p>Remove an existing follow relationship with the specified account. Has no effect if the authenticated user is not currently following the account.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:write</code></li> </ul> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>account_id</code></td> <td>path</td> <td>yes</td> <td>integer</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="204">204</h3> <p>unfollow</p> https://cookifed.dev/docs/api/v1/account/get-accounts-relationships/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/get-accounts-relationships/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">GET /api/v1/accounts/relationships</span></span></code></pre></div> </figure> </div> <p>Return the follow and block relationship state between the authenticated user and each account specified via the id query parameter array.</p> <h2 id="required-scopes">Required Scopes</h2> <ul> <li><code>account:read</code></li> </ul> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>query</td> <td>no</td> <td>array[number]</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="200">200</h3> <p>relationships</p> <p><strong>Schema:</strong> array[object]</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>number</td> <td>yes</td> <td></td> </tr> <tr> <td><code>following</code></td> <td>boolean</td> <td>yes</td> <td></td> </tr> <tr> <td><code>followed</code></td> <td>boolean</td> <td>yes</td> <td></td> </tr> <tr> <td><code>following_requested</code></td> <td>boolean</td> <td>yes</td> <td></td> </tr> <tr> <td><code>follower_requested</code></td> <td>boolean</td> <td>yes</td> <td></td> </tr> <tr> <td><code>blocking</code></td> <td>boolean</td> <td>yes</td> <td></td> </tr> </tbody> </table> https://cookifed.dev/docs/api/v1/account/get-accounts-id_or_username/ Mon, 01 Jan 0001 00:00:00 +0000 https://cookifed.dev/docs/api/v1/account/get-accounts-id_or_username/ <div class="expressive-code"> <figure class="frame not-content"> <figcaption class="header"> <span class="title"></span> </figcaption> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">GET /api/v1/accounts/{id_or_username}</span></span></code></pre></div> </figure> </div> <p>Fetch a single account by its numeric ID or username. Returns public profile data including avatar, bio, and account state.</p> <h2 id="required-scopes">Required Scopes</h2> <p><em>None (public endpoint).</em></p> <h2 id="parameters">Parameters</h2> <table> <thead> <tr> <th>Name</th> <th>In</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id_or_username</code></td> <td>path</td> <td>yes</td> <td>string</td> <td></td> </tr> </tbody> </table> <h2 id="request-body">Request Body</h2> <p><em>None.</em></p> <h2 id="responses">Responses</h2> <h3 id="200">200</h3> <p>account available</p> <p><strong>Schema:</strong> <code>account_output</code></p> <h4 id="account_output"><code>account_output</code></h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>username</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>name</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>summary_html</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>instance</code></td> <td>string</td> <td>yes</td> <td></td> </tr> <tr> <td><code>avatar</code></td> <td>object</td> <td>yes</td> <td></td> </tr> <tr> <td><code>state</code></td> <td>string</td> <td>yes</td> <td>The account&rsquo;s current sync status. - <code>unknown</code>: We don&rsquo;t know anything about this account. It may not even exist. - <code>loading</code>: We have loaded this account&rsquo;s direct information, and are currently loading the statuses. - <code>loaded</code>: We have loaded the data from this account. Note that this doesn&rsquo;t mean we actually have 100% of the data. There could be new data we haven&rsquo;t loaded yet, or that wasn&rsquo;t delivered to us. Local and managed accounts always have a state of <code>loaded</code>.</td> </tr> <tr> <td><code>following_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>followers_count</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> <tr> <td><code>like_id</code></td> <td>integer</td> <td>yes</td> <td></td> </tr> </tbody> </table>