XExenforo-ltd
Media

Get a list of media items

Changed on

Get a list of media items.

get/media/

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

Query parameters

pageinteger
media_typestring

Filters to only media of the specified type. Valid types: image, audio, video, embed.

user_idinteger

Filters to only media created by the specified user ID.

orderstring

Method of ordering: media_date, 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

  • e271d0e41f6dRevision changes
    • breaking

      the response's property type changed from string to object for status

    • info

      api operation id get_media_ removed and replaced with getMedia

    • 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

  • 0f490cfb7931Revision changes
    • info

      api tag Media added

    • info

      api tag media removed

    • info

      added the new optional query request parameter direction

    • info

      added the new optional query request parameter media_type

    • 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