Mastodon
  • What is Mastodon?
  • Using Mastodon
    • Signing up for an account
    • Setting up your profile
    • Posting to your profile
    • Using the network features
    • Dealing with unwanted content
    • Promoting yourself and others
    • Set your preferences
    • More settings
    • Using Mastodon externally
    • Moving or leaving accounts
    • Running your own server
  • Running Mastodon
    • Preparing your machine
    • Installing from source
    • Configuring your environment
    • Configuring full-text search
    • Installing optional features
      • Object storage
      • Onion services
      • Captcha
      • Single Sign On
    • Setting up your new instance
    • Using the admin CLI
    • Upgrading to a new release
    • Backing up your server
    • Migrating to a new machine
    • Scaling up your server
    • Moderation actions
    • Troubleshooting errors
      • Database index corruption
    • Roles
  • Developing Mastodon apps
    • Getting started with the API
    • Playing with public data
    • Obtaining client app access
    • Logging in with an account
    • Libraries and implementations
  • Contributing to Mastodon
    • Technical overview
    • Setting up a dev environment
    • Code structure
    • Routes
    • Bug bounties and responsible disclosure
  • Spec compliance
    • ActivityPub
    • WebFinger
    • Security
    • Microformats
    • OAuth
    • Bearcaps
  • REST API
    • Datetime formats
    • Guidelines and best practices
    • OAuth Tokens
    • OAuth Scopes
    • Rate limits
  • API Methods
    • apps
      • oauth
      • emails
    • accounts
      • bookmarks
      • favourites
      • mutes
      • blocks
      • domain_blocks
      • filters
      • reports
      • follow_requests
      • endorsements
      • featured_tags
      • preferences
      • followed_tags
      • suggestions
      • tags
    • profile
    • statuses
      • media
      • polls
      • scheduled_statuses
    • timelines
      • conversations
      • lists
      • markers
      • streaming
    • grouped notifications
    • notifications
      • push
    • search
    • instance
      • trends
      • directory
      • custom_emojis
      • announcements
    • admin
      • accounts
      • canonical_email_blocks
      • dimensions
      • domain_allows
      • domain_blocks
      • email_domain_blocks
      • ip_blocks
      • measures
      • reports
      • retention
      • trends
    • proofs
    • oembed
  • API Entities
    • Account
    • AccountWarning
    • Admin::Account
    • Admin::CanonicalEmailBlock
    • Admin::Cohort
    • Admin::Dimension
    • Admin::DomainAllow
    • Admin::DomainBlock
    • Admin::EmailDomainBlock
    • Admin::Ip
    • Admin::IpBlock
    • Admin::Measure
    • Admin::Report
    • Announcement
    • Appeal
    • Application
    • Context
    • Conversation
    • CustomEmoji
    • DomainBlock
    • Error
    • ExtendedDescription
    • FamiliarFollowers
    • FeaturedTag
    • Filter
    • FilterKeyword
    • FilterResult
    • FilterStatus
    • IdentityProof
    • Instance
    • List
    • Marker
    • MediaAttachment
    • Notification
    • NotificationPolicy
    • NotificationRequest
    • Poll
    • Preferences
    • PreviewCard
    • PreviewCardAuthor
    • PrivacyPolicy
    • Quote
    • Reaction
    • Relationship
    • RelationshipSeveranceEvent
    • Report
    • Role
    • Rule
    • ScheduledStatus
    • Search
    • ShallowQuote
    • Status
    • StatusEdit
    • StatusSource
    • Suggestion
    • Tag
    • TermsOfService
    • Token
    • Translation
    • V1::Filter
    • V1::Instance
    • V1::NotificationPolicy
    • WebPushSubscription

lists API methods

View and manage lists. See also: /api/v1/timelines/list/id for loading a list timeline.

    • View your lists
    • Show a single list
    • Create a list
    • Update a list
    • Delete a list
    • View accounts in a list
    • Add accounts to a list
      • Request
    • Remove accounts from list
    • See also

View your lists

GET /api/v1/lists HTTP/1.1

Fetch all lists that the user owns.

Returns: Array of List
OAuth: User token + read:lists
Version history:
2.1.0 - added

Request

Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.

Response

200: OK

Use id as a parameter for related API calls.

[
  {
    "id": "12249",
    "title": "Friends",
    "replies_policy": "followed",
    "exclusive": false
  },
  {
    "id": "13585",
    "title": "test",
    "replies_policy": "list",
    "exclusive": true
  }
]
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}

Show a single list

GET /api/v1/lists/:id HTTP/1.1

Fetch the list with the given ID. Used for verifying the title of a list, and which replies to show within that list.

Returns: List
OAuth: User token + read:lists
Version history:
2.1.0 - added

Request

Path parameters
:id
required String. The ID of the List in the database.
Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.

Response

200: OK

The list 12249 exists and is owned by you

{
  "id": "12249",
  "title": "Friends",
  "replies_policy": "followed",
  "exclusive": false
}
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}
404: Not found

List does not exist or is not owned by you

{
  "error": "Record not found"
}

Create a list

POST /api/v1/lists HTTP/1.1

Create a new list.

Returns: List
OAuth: User token + write:lists
Version history:
2.1.0 - added
3.3.0 - added replies_policy
4.2.0 - added exclusive

Request

Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.
Form data parameters
title
required String. The title of the list to be created.
replies_policy
String. One of followed, list, or none. Defaults to list.
exclusive
Boolean. Whether members of this list need to get removed from the “Home” feed

Response

200: OK

A sample list was created with a title of “test”.

{
  "id": "13585",
  "title": "test",
  "replies_policy": "list",
  "exclusive": false
}
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}
422: Unprocessable entity

If the title is missing:

{
  "error": "Validation failed: Title can't be blank"
}

If the replies_policy is not understood:

{
  "error": "'some' is not a valid replies_policy"
}

–>


Update a list

PUT /api/v1/lists/:id HTTP/1.1

Change the title of a list, or which replies to show.

Returns: List
OAuth: User token + write:lists
Version history:
2.1.0 - added
3.3.0 - added replies_policy

Request

Path parameters
:id
required String. The ID of the List in the database.
Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.
Form data parameters
title
required String. The title of the list to be created.
replies_policy
String. One of followed, list, or none. Defaults to list.
exclusive
Boolean. Whether members of this list need to get removed from the “Home” feed

Response

200: OK

The title of list 13585 was successfully updated to “testing”

{
  "id": "13585",
  "title": "test",
  "replies_policy": "list",
  "exclusive": false
}
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}
422: Unprocessable entity

If the title is missing:

{
  "error": "Validation failed: Title can't be blank"
}

If the replies_policy is not understood:

{
  "error": "'some' is not a valid replies_policy"
}

Delete a list

DELETE /api/v1/lists/:id HTTP/1.1

Returns: Empty
OAuth: User token + write:lists
Version history:
2.1.0 - added

Request

Path parameters
:id
required String. The ID of the List in the database.
Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.

Response

200: OK

List was successfully deleted

{}
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}
404: Not found

List does not exist or is not owned by you

{
  "error": "Record not found"
}

View accounts in a list

GET /api/v1/lists/:id/accounts HTTP/1.1

Returns: Array of Account
OAuth: User token + read:lists
Version history:
2.1.0 - added
3.3.0 - both min_id and max_id can be used at the same time now

Request

Path parameters
:id
required String. The ID of the List in the database.
Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.
Query parameters
max_id
Internal parameter. Use HTTP Link header for pagination.
since_id
Internal parameter. Use HTTP Link header for pagination.
min_id
Internal parameter. Use HTTP Link header for pagination.
limit
Integer. Maximum number of results. Defaults to 40 accounts. Max 80 accounts. Set to 0 in order to get all accounts without pagination.

Response

200: OK
[
  {
    "id": "952529",
    "username": "alayna",
    "acct": "alayna@desvox.es",
    // ...
  },
  {
    "id": "917388",
    "username": "cole",
    "acct": "cole@be.cutewith.me",
    // ...
  },
  {
    "id": "869022",
    "username": "alayna",
    "acct": "alayna@be.cutewith.me",
    // ...
  },
  {
    "id": "832844",
    "username": "a9",
    "acct": "a9@broadcast.wolfgirl.engineering",
    // ...
  },
  {
    "id": "482403",
    "username": "amic",
    "acct": "amic@nulled.red",
    // ...
  }
]

Because you do not know beforehand which Accounts are included in a List, you will have to parse the HTTP Link header to load older or newer results. See Paginating through API responses for more information.

Link: <https://mastodon.example/api/v1/lists/12249/accounts?max_id=106931203247163945>; rel="next", <https://mastodon.example/api/v1/lists/12249/accounts?since_id=108632085572655915>; rel="prev"
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}
404: Not found

List does not exist or is not owned by you.

{
  "error": "Record not found"
}

Add accounts to a list

POST /api/v1/lists/:id/accounts HTTP/1.1

Add accounts to the given list. Note that the user must be following these accounts.

Returns: Empty
OAuth: User token + write:lists
Version history:
2.1.0 - added

Request

Path parameters
:id
required String. The ID of the List in the database.
Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.
Form data parameters
account_ids[]
required Array of String. The accounts that should be added to the list.

Response

200: OK
{}
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}
404: Not found

You are not following a given account ID, or you do not own the list ID, or list/account ID does not exist

{
  "error": "Record not found"
}
422: Unprocessable entity

An Account with one of the provided IDs is already in the list

{
  "error": "Validation failed: Account has already been taken"
}

Remove accounts from list

DELETE /api/v1/lists/:id/accounts HTTP/1.1

Remove accounts from the given list.

Returns: Empty
OAuth: User token + write:lists
Version history:
2.1.0 - added

Request

Path parameters
:id
required String. The ID of the List in the database.
Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.
Form data parameters
account_ids[]
required Array of String. The accounts that should be removed from the list.

Response

200: OK

Account was successfully removed from the list, or it was already not in the list.

{}
401: Unauthorized

Invalid or missing Authorization header.

{
  "error": "The access token is invalid"
}
404: Not found

List is not owned by you or does not exist

{
  "error": "Record not found"
}

See also

GET /api/v1/accounts/:id/lists
app/controllers/api/v1/lists_controller.rb
app/controllers/api/v1/lists/accounts_controller.rb

Last updated October 10, 2024 · Improve this page

Sponsored by

Dotcom-Monitor LoadView Stephen Tures Swayable SponsorMotion

Join Mastodon · Blog ·

View source · CC BY-SA 4.0 · Imprint