Media

Get information about the specified media item

Changed on Mar 18, 2026

Get information about the specified media item.

get/media/{id}/

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/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

with_commentsboolean

If specified, the response will include a page of comments.

pageinteger

Response

OK

Changes

Mar 18, 2026e271d0e41f6d Revision changes
- breaking
  the response's property type changed from string to object for status
- warning
  deleted the path request parameter id
- info
  api operation id get_media_id_ removed and replaced with getMediaId
- 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 added
- info
  api tag media removed
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter with_comments
- info
  added the media type application/json for the response with the status

Operation history (4 revisions)