Graph API Version

Business User

Reading

Represents a business user.

Example

Graph API Explorer
GET /v5.0/{business-user-id} 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-user-id}',
    '{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-user-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-user-id}",
    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:@"/{business-user-id}"
                                      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

FieldDescription
id
numeric string

The business user's ID.

business

Business user is associated with this business.

email
string

User's email as provided in Business Manager.

finance_permission
string

Financial permission role of the user in Business Manager, such as EDITOR, ANALYST, and so on.

first_name
string

User's first name as provided in Business Manager.

ip_permission
string

This user's ads right permission role in Business Manager, such as Reviewer and so on.

last_name
string

User's last name as provided in Business Manager.

name
string

Name of user as provided in Business Manager.

pending_email
string

Email for the business user that is still pending verification.

role
string

Role of the user in Business Manager, such as Admin, Employee, and so on.

title
string

The title of the user in this business.

two_fac_status
string

Two-factor authentication status of the business-scoped user.

Edges

EdgeDescription

Ad accounts that are assigned to this business scoped user

Business asset groups that are assign to this business scoped user

Pages that are assigned to this business scoped user

Product catalogs that are assigned to this business scoped user

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Creating

You can't perform this operation on this endpoint.

Updating

You can update a BusinessUser by making a POST request to /{business_user_id}.

Parameters

ParameterDescription
email
string

The email of the user at this business.

first_name
string

First name for this business user.

last_name
string

Last name for this business user.

role
enum {FINANCE_EDITOR, FINANCE_ANALYST, ADS_RIGHTS_REVIEWER, ADMIN, EMPLOYEE}

The role of the user at this business, such as ADMIN and so on.

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
3914It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager.
100Invalid parameter

Deleting

You can delete a BusinessUser by making a DELETE request to /{business_user_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter
294Managing advertisements requires an access token with the extended permission for ads_management