Graph API Version

Page Instant Articles

Reading

Instant articles associated with this Page

Graph API Explorer
GET /v2.10/{page-id}/instant_articles HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{page-id}/instant_articles'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* 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();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* 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
}];

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • manage_pages
  • pages_show_list
  • pages_manage_instant_articles
Page management Apps
  • manage_pages
  • pages_show_list
  • pages_manage_instant_articles
Other Apps
No data

Parameters

NameDescription
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

Validation Rules

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.

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • manage_pages
  • pages_show_list
  • pages_manage_instant_articles
Page management Apps
  • pages_show_list
  • pages_manage_instant_articles
Other Apps
No data

Parameters

NameDescription
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,
}

Validation Rules

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.