GET /sites/$site/media/

Get a list of items in the media library.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/media/
Requires authentication? Yes

Method Parameters

Parameter Type Description
$site (int|string) Site ID or domain

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.
number (int) The number of media items to return. Limit: 100. Default: 20.
offset (int) 0-indexed offset.
page (int) Return the Nth 1-indexed page of posts. Takes precedence over the offset parameter.
page_handle (string) A page handle, returned from a previous API call as a meta.next_page property. This is the most efficient way to fetch the next page of results.
order (string)
DESC:
(default) Return files in descending order. For dates, that means newest to oldest.
ASC:
Return files in ascending order. For dates, that means oldest to newest.
order_by (string)
date:
(default) Order by the uploaded time of each file.
title:
Order lexicographically by file titles.
ID:
Order by media ID.
search (string) Search query.
post_ID (int) Default is showing all items. The post where the media item is attached. 0 shows unattached media items.
mime_type (string) Default is empty. Filter by mime type (e.g., 'image/jpeg', 'application/pdf'). Partial searches also work (e.g. passing 'image' will search for all image files).
after (iso 8601 datetime) Return media items uploaded after the specified datetime.
before (iso 8601 datetime) Return media items uploaded before the specified datetime.

Response Parameters

Parameter Type Description
media (array) Array of media objects
found (int) The number of total results found
meta (object) Meta data

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
403 unauthorized User cannot access this private blog.
403 unauthorized User cannot access this restricted blog
404 unknown_media Unknown Media
403 unauthorized User cannot view media
400 invalid_number The NUMBER parameter must be less than or equal to 100.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

null