directory

A directory of profiles that your website is aware of.

get
View profile directory

https://mastodon.example/api/v1/directory

List accounts visible in the directory.

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

Request

Query Parameters
offset
optional
string
How many accounts to skip before returning results. Default 0.
limit
optional
string
How many accounts to load. Default 40.
order
optional
string
active to sort by most recently posted statuses (default) or new to sort by most recently created profiles.
local
optional
boolean
Only return local accounts.

Response

200: Success

Sample results with limit=2

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

Last updated December 27, 2020 · Improve this page