Graph API
Graph API Version

Page Instant Articles

Reading

Retrieve a list of Instant Articles for a page.

Requirements

For Pages you own or for which you can perform the MODERATE task, you will need:

For Page you do not own or which you can not perform the MODERATE task, you will need:

  • The Page Public Content Access feature
When using the Page Public Content Access feature, use a system user access token to avoid rate limiting issues.

Feature Permissions

NameDescription
Page Public Content AccessThis feature permission may be required.

Example

Graph API Explorer
GET /v10.0/{page-id}/instant_articles HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{page-id}/instant_articles',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/instant_articles",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/instant_articles",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/instant_articles"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

ParameterDescription
development_mode
boolean
Default value: false

Whether to show development articles or production articles.

Fields

Reading from this edge will return a JSON formatted result:

{
    "data": [],
    "paging": {},
    "summary": {}
}

data

A list of InstantArticle nodes.

paging

For more details about pagination, see the Graph API guide.

summary

Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=total_count).

FieldDescription
total_count
unsigned int32

The total number of instant articles associated with this Page.

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter

Creating

You can make a POST request to instant_articles edge from the following paths:
When posting to this edge, an InstantArticle will be created.

Parameters

ParameterDescription
development_mode
boolean

A flag indicating whether the article will be placed in development mode

html_source
string

The HTML markup to use when generating the Instant Article

RequiredSupports Emoji
published
boolean

A flag indicating whether the article will be published immediately

take_live
boolean

A flag indicating whether the article will be published immediately (deprecated)

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.