documentation/directory.md at 9bea3ee51a8314da61a3bc3a200882ef1fa62214

mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

* add identifier for troubleshooting pages

* mention mutes can be temporary now

* bell for notifications

* convert images to jpg and rename them

* suspensions now reversible

* unread notifications

* suspended: true

* mutes expiry

* replies_policy, type of notification

* notify

* featuredTags AP representation

* new env vars

* accounts merge

* maintenance cli

* list replies

* suspended flag

* follower sync

* minor formatting

* add note about idempotency of follow action

* account featured tags, min_id and max_id, plus normalization

* follow marcin and nightpool's suggestion

* bearcaps

* replies_policy update

* featuredtags now have a url

2020-12-27 07:03:55 +01:00

1.9 KiB

Raw Blame History

title

description

directory

A directory of profiles that your website is aware of.

docs

weight	parent
20	methods-instance

{{< api-method method="get" host="https://mastodon.example" path="/api/v1/directory" title="View profile directory" >}} {{< api-method-description >}}

List accounts visible in the directory.

Returns: Array of Account
OAuth: Public
Version history:
3.0.0 - added

{{< endapi-method-description >}} {{< api-method-spec >}} {{< api-method-request >}} {{< api-method-query-parameters >}} {{< api-method-parameter name="offset" type="string" required=false >}} How many accounts to skip before returning results. Default 0. {{< endapi-method-parameter >}} {{< api-method-parameter name="limit" type="string" required=false >}} How many accounts to load. Default 40. {{< endapi-method-parameter >}} {{< api-method-parameter name="order" type="string" required=false >}} active to sort by most recently posted statuses default or new to sort by most recently created profiles. {{< endapi-method-parameter >}} {{< api-method-parameter name="local" type="boolean" required=false >}} Only return local accounts. {{< endapi-method-parameter >}} {{< endapi-method-query-parameters >}} {{< endapi-method-request >}} {{< api-method-response >}} {{< api-method-response-example httpCode=200 >}} {{< api-method-response-example-description >}}

Sample results with limit=2 {{< endapi-method-response-example-description >}}

[
  {
    "id": "796927",
    "username": "eternalNo3",
    "acct": "eternalNo3@best-friends.chat",
    "display_name": "ESD＠┓（谷）┏",
    ...
  },
  {
    "id": "787648",
    "username": "ariel",
    "acct": "ariel@best-friends.chat",
    "display_name": "あやっしー🧜🏻‍♀️",
    ...
  }
]

1.9 KiB Raw Blame History Unescape Escape

1.9 KiB

Raw Blame History