Alerts5

Attachments8

Auth3

Conversations15

Featured content1

Forums3

Index1

Me6

Media10

Media albums8

Media categories7

Media comments6

Nodes6

OAuth24

oEmbed1

Posts7

Profile posts11

Resource categories7

Resource reviews6

Resource updates4

Resource versions4

Resources10

Search4

Search forums2

Stats1

Threads12

Users10

Media albums

Get a list of albums

Changed on Mar 18, 2026

Get a list of albums.

get/media-albums/

Request

Base URL
https://example.com/api
Auth
- OAuth 2
  Authorization codehttps://example.com/oauth2/authorize
  Token URLhttps://example.com/api/oauth2/token
  Scopesmedia:read
- or API key in header XF-Api-Key
TypeScript
https://skmtc.dev/xenforo-ltd/apis/xenforo-api/docs/media-albums/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

user_idinteger

Filters to only albums created by the specified user ID.

orderstring

Method of ordering: create_date, media_count, comment_count, rating_weighted, reaction_score, view_count

directionstring

Either "asc" or "desc" for ascending or descending. Applies only if an order is provided.

Response

OK

Changes

Mar 18, 2026e271d0e41f6d Revision changes
- breaking
  the response's property type changed from string to object for status
- info
  api operation id get_media_albums_ removed and replaced with getMediaAlbums
- info
  the endpoint scheme security XF-Api-Key was added to the API
- info
  the endpoint scheme security XF-OAuth2 was added to the API
- info
  added the new optional header request parameter XF-Api-User to all path's operations
- info
  added the new optional query request parameter api_bypass_permissions to all path's operations
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
Mar 6, 20260f490cfb7931 Revision changes
- info
  api tag Media albums added
- info
  api tag media-albums removed
- info
  added the new optional query request parameter direction
- info
  added the new optional query request parameter order
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter user_id
- info
  added the media type application/json for the response with the status

Operation history (4 revisions)