Sign in

v1

latestOpenAPI 3.0.32026-07-1412735131.4 KB

View accounts in List

get/api/v1/lists/{id}/accounts

Query parameters

limitinteger

Maximum number of results. Defaults to 40. Max 40. Set to 0 in order to get all accounts without pagination. Pagination is done with the HTTP Link header.

max_idstring

Return results older than ID

since_idstring

Return results newer than ID

Response

Success

acctstring

The Webfinger account URI. Equal to username for local users, or username@domain for

avatarstring

An image icon that is shown next to statuses and in the profile. The format is URL.

avatar_staticstring

A static version of the avatar. Equal to avatar if its value is a static image; different if avatar is an animated GIF. The format is URL.

botboolean

A presentational flag. Indicates that the account may perform automated actions, may not be monitored, or identifies as a robot.

created_atstring date-time

When the account was created.

discoverableboolean

Whether the account has opted into discovery features such as the profile directory.

display_namestring

The profile's display name.

followers_countinteger

The reported followers of this profile.

following_countinteger

The reported follows of this profile.

headerstring

An image banner that is shown above the profile and in profile cards. The format is URL.

header_staticstring

A static version of the header. Equal to header if its value is a static image; different if header is an animated GIF. The format is URL.

idstring

The account id header.

last_status_atstring date-time

When the most recent status was posted.

lockedboolean

Whether the account manually approves follow requests.

mute_expires_atstring date-time

When a timed mute will expire, if applicable. ISO 8601 Datetime.

notestring

The profile's bio / description.

statuses_countinteger

How many statuses are attached to this account.

suspendedboolean

An extra entity returned when an account is suspended.

urlstring

The location of the user's profile page. (HTTPS URL)

usernamestring

The username of the account, not including domain.