Mastodon

List Mastodon profile collections

List an account's curated collections of accounts (Mastodon 4.7 and later), with the member accounts.

GET/v1/mastodon/profiles/{handle}/collections
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
1
handlestringrequiredpath

Account handle with its home server, e.g. `Gargron@mastodon.social`. A leading `acct:` or `@`, or a profile URL (`https://mastodon.social/@Gargron`, `https://mastodon.social/web/@Gargron`) is also accepted.

Response fields
89

Endpoint-specific response payload.

datalookupStatus
string

`found`, `not_found`, `restricted` (login required or closed), `unsupported` (this server does not offer it) or `not_compatible` (the host is not a Mastodon-compatible server). See `reason`.

one of: found, not_found, restricted, unsupported, not_compatible

datahost
string

The server that was asked.

datasoftware
stringnullableoptional

Only on a `not_compatible` result (and always on the server endpoint): the software the host runs, from its NodeInfo, e.g. `misskey` or `lemmy`; null when it does not say. Absent otherwise.

Why `lookupStatus` is not `found`, or null when it is `found`.

datareasoncode
string

Machine-readable reason.

one of: login_required, closed_by_operator, hidden_by_owner, suspended, not_implemented, disabled_by_operator, not_a_mastodon_server, unsupported_server_software, host_not_found, post_not_visible

datareasonmessage
string

Plain-language explanation.

The account, when the server returned it.

dataprofileid
string

Account id on `host`.

dataprofilehost
string

The server this record came from.

dataprofilehandle
string

`user@host`, with the account's home server.

dataprofileurl
stringnullable

Profile page.

dataprofiledisplayName
stringnullable

Display name.

Curated collections the account owns, newest first.

datacollections[]id
string

Collection id on `host`.

datacollections[]name
string

Collection name.

datacollections[]description
stringnullable

Collection description.

datacollections[]language
stringnullable

ISO language code of the collection, when set.

Hashtag the collection gathers, when it has one.

datacollections[]hashtagname
string

Hashtag name without the `#`.

datacollections[]hashtagurl
stringnullable

Hashtag page on the server.

datacollections[]url
stringnullable

Collection page.

datacollections[]uri
stringnullable

ActivityPub id of the collection.

datacollections[]isLocal
booleannullable

True when the collection belongs to this server.

datacollections[]isDiscoverable
booleannullable

True when the collection is listed publicly.

datacollections[]isSensitive
booleannullable

True when the collection is marked sensitive.

datacollections[]itemCount
integernullable

Accounts in the collection, across every page.

datacollections[]createdAt
stringnullable

When the collection was created, ISO-8601 UTC.

datacollections[]updatedAt
stringnullable

When the collection was last changed, ISO-8601 UTC.

Members of the collection.

datacollections[]items[]id
string

Membership id on `host`.

datacollections[]items[]state
stringnullable

Membership state, such as `accepted`.

datacollections[]items[]accountId
stringnullable

Id of the member account, on `host`.

datacollections[]items[]createdAt
stringnullable

When the account was added, ISO-8601 UTC.

The member account, when available.

datacollections[]items[]accountid
string

Account id on `host`.

datacollections[]items[]accounthost
string

The server this record came from.

datacollections[]items[]accounthandle
string

`user@host`, with the account's home server.

datacollections[]items[]accountusername
string

Username without the host.

datacollections[]items[]accounturl
stringnullable

Profile page.

datacollections[]items[]accountactorUri
stringnullable

ActivityPub id, when the server shows it.

datacollections[]items[]accountdisplayName
stringnullable

Display name.

datacollections[]items[]accountbioHtml
stringnullable

Bio as sanitised HTML.

datacollections[]items[]accountbio
stringnullable

Bio as plain text.

An avatar or header image.

datacollections[]items[]accountavatarurl
stringnullable

Image URL on the server or its media store.

datacollections[]items[]accountavatarstaticUrl
stringnullable

Still frame of an animated image.

datacollections[]items[]accountavatardescription
stringnullable

Alt text.

An avatar or header image.

datacollections[]items[]accountheaderurl
stringnullable

Image URL on the server or its media store.

datacollections[]items[]accountheaderstaticUrl
stringnullable

Still frame of an animated image.

datacollections[]items[]accountheaderdescription
stringnullable

Alt text.

datacollections[]items[]accountcreatedAt
stringnullable

Account creation, rounded to midnight UTC by the server.

datacollections[]items[]accountlastPostDate
stringnullable

Date of the latest post (a date, not a time).

The server's own counters.

datacollections[]items[]accountstatsfollowers
integernullable

Accounts following this account.

datacollections[]items[]accountstatsfollowing
integernullable

Accounts this account follows.

datacollections[]items[]accountstatsposts
integernullable

Posts by this account.

datacollections[]items[]accountisBot
boolean

True when the account is marked as a bot.

datacollections[]items[]accountisGroup
boolean

True when the account is a group.

datacollections[]items[]accountisLocked
boolean

Follow requests need approval. Public posts are still public.

datacollections[]items[]accountisLimited
boolean

The server's moderators limited (silenced) the account.

datacollections[]items[]accountisSuspended
boolean

True when the server suspended the account.

datacollections[]items[]accountisDiscoverable
booleannullable

The owner's opt-in to the profile directory and recommendations. null on servers that do not report it.

datacollections[]items[]accountisIndexable
booleannullable

The owner's opt-in to search engines indexing public posts. null when not reported.

datacollections[]items[]accountnoIndex
booleannullable

The owner asks search engines to skip the profile. null when not reported.

datacollections[]items[]accounthidesNetwork
booleannullable

The owner hides the follower and following lists. null when not reported.

The account this one moved to.

datacollections[]items[]accountmovedToid
stringnullable

Account id on the server that returned it.

datacollections[]items[]accountmovedTohandle
string

`user@host` of the account this one moved to.

datacollections[]items[]accountmovedTourl
stringnullable

Profile page of the new account.

datacollections[]items[]accountmovedTodisplayName
stringnullable

Display name of the new account.

Profile metadata fields, in the owner's order.

datacollections[]items[]accountfields[]name
string

Label.

datacollections[]items[]accountfields[]valueHtml
string

Value as sanitised HTML.

datacollections[]items[]accountfields[]value
string

Value as plain text.

datacollections[]items[]accountfields[]verifiedAt
stringnullable

When a link in the value was verified with rel=me.

Custom emojis used in the display name or bio.

datacollections[]items[]accountemojis[]shortcode
string

Shortcode without colons.

datacollections[]items[]accountemojis[]url
stringnullable

Emoji image.

datacollections[]items[]accountemojis[]staticUrl
stringnullable

Still frame.

Public badges such as Owner or Moderator.

datacollections[]items[]accountroles[]id
stringnullable

Role id on `host`.

datacollections[]items[]accountroles[]name
string

Role name, such as Owner or Moderator.

datacollections[]items[]accountroles[]color
stringnullable

Badge colour as a hex value, when set.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/mastodon/profiles/Gargron%40mastodon.social/collections" \
  -H "x-api-key: YOUR_API_KEY"

Responses

The account's curated collections.