In Graph API v9.0, access to this endpoint was restricted. In Graph API v10.0, access has been restored to all apps, but apps can now only target businesses (or child businesses of those businesses) that have claimed them.
Represents a business user. A business user can be an employee of the business or an admin of the business. An Employee can see all of information in business settings and be assigned roles by business admins. An Admin can control all aspects of the business including modifying or deleting the account and adding or removing people from the employee list
GET /v21.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();
/* 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
}];
Field | Description |
---|---|
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 |
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. |
Edge | Description |
---|---|
Edge<BusinessAssetGroup> | Business asset groups that are assign to this business scoped user |
Edge<Page> | Pages that are assigned to this business scoped user |
Edge<ProductCatalog> | Product catalogs that are assigned to this business scoped user |
Error | Description |
---|---|
100 | Invalid parameter |
104 | Incorrect signature |
business_users
edge from the following paths: Parameter | Description |
---|---|
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. |
id
in the return type.id
: numeric string, Error | Description |
---|---|
100 | Invalid parameter |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
613 | Calls to this api have exceeded the rate limit. |
457 | The session has an invalid origin |
190 | Invalid OAuth 2.0 Access Token |
415 | Two 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. |
200 | Permissions error |
104 | Incorrect signature |
/{business_user_id}
.Parameter | Description |
---|---|
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, DEVELOPER, PARTNER_CENTER_ADMIN, PARTNER_CENTER_ANALYST, PARTNER_CENTER_OPERATIONS, PARTNER_CENTER_MARKETING, PARTNER_CENTER_EDUCATION, MANAGE, DEFAULT, FINANCE_EDIT, FINANCE_VIEW} | The role of the user at this business, such as |
skip_verification_email boolean | Whether to skip sending the verification email. The business persona email still requires verification - but just won't receive an email. |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
415 | Two 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. |
190 | Invalid OAuth 2.0 Access Token |
3914 | It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager. |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
/{business_user_id}
.success
: bool, Error | Description |
---|---|
3914 | It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager. |
200 | Permissions error |
100 | Invalid parameter |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
190 | Invalid OAuth 2.0 Access Token |