Graph API Version

Page Roles

Reading

People who have a role on a Page

Limitations

  • This edge only returns people who do not belong to a business. To find business users, query the Page Assigned Users edge.

New Page Experience

This endpoint is supported for New Page Experience.

Example

Graph API Explorer
GET /v19.0/{page-id}/roles 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}/roles',
    '{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}/roles",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/roles",
    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}/roles"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v19.0/{page-id}/roles
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

ParameterDescription
include_deactivated
boolean
Default value: false

Include deactivated accounts in the results

uid
UID

ID of a person who has a role on the Page

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of User nodes.

The following fields will be added to each node that is returned:

FieldDescription
is_active
bool

If the account is active

tasks
list<enum>

Tasks for this person. Can choose from MANAGE, CREATE_CONTENT, MODERATE, ADVERTISE and ANALYZE

paging

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

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
283That action requires the extended permission pages_read_engagement and/or pages_read_user_content and/or pages_manage_ads and/or pages_manage_metadata
104Incorrect signature
190Invalid OAuth 2.0 Access Token
80001There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.