Graph API Version

Business Business Users

Reading

List all business users associated with this business.

Example

Graph API Explorer
GET /v21.0/{business-id}/business_users 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(
    '/{business-id}/business_users',
    '{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(
    "/{business-id}/business_users",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-id}/business_users",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{business-id}/business_users"
                                      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

This endpoint doesn't have any parameters.

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of BusinessUser nodes.

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

FieldDescription
role
string

Role name of the user in the business manager. Note that this field only contains base roles including Admin and Employee

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

Total number of business users associated with this business.

Error Codes

ErrorDescription
200Permissions error
190Invalid OAuth 2.0 Access Token
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed
104Incorrect signature

Creating

Apps can only target businesses (or child businesses of those businesses) that have claimed them.

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

Parameters

ParameterDescription
email
string

Email of user to be added to this business.

Required
invited_user_type
array<enum {FB, MWA}>

Not passing a value will default to 'FB'.

Use 'MWA' for inviting a user with their Meta account managed by their organization.

role
enum {FINANCE_EDITOR, FINANCE_ANALYST, ADS_RIGHTS_REVIEWER, ADMIN, EMPLOYEE, DEVELOPER, PARTNER_CENTER_ADMIN, PARTNER_CENTER_ANALYST, PARTNER_CENTER_OPERATIONS, PARTNER_CENTER_MARKETING, PARTNER_CENTER_EDUCATION, MANAGE, DEFAULT, FINANCE_EDIT, FINANCE_VIEW}

Role of user to add to this business.

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
368The action attempted has been deemed abusive or is otherwise disallowed
100Invalid parameter
613Calls to this api have exceeded the rate limit.
190Invalid OAuth 2.0 Access Token
415Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
457The session has an invalid origin
200Permissions error
104Incorrect signature

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.