Facebook

Graph API Reference v21.0: Business Clients - Documentation - Meta for Developers

Graph API Version

v21.0

Business Clients

Reading

List all businesses that gave you access to one or more of their assets.

Example

Graph API Explorer

 GET /v21.0/{business-id}/clients 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}/clients',
    '{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}/clients",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

 /* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-id}/clients",
    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}/clients"
                                      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 Business nodes.

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

Field	Description
`adaccount_permissions` list<AdAccountPermission>	Adaccount_permissions Default
`application_permissions` list<AppPermission>	Application_permissions Default
`page_permissions` list<PagePermission>	Page_permissions Default
`productcatalog_permissions` list<ProductCatalogPermission>	Productcatalog_permissions Default
`shared_ca_count` int32	Shared_ca_count Default

`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 ).

Field	Description
`total_count` unsigned int32	Total number of businesses.

Error Codes

Error	Description
190	Invalid OAuth 2.0 Access Token
100	Invalid parameter
200	Permissions error

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can dissociate a Business from a Business by making a DELETE request to /{business_id}/clients .

Parameters

Parameter	Description
`business` numeric string or integer	The client's business. Required

Return Type

Struct {

success : bool,

}

Error Codes

Error	Description
100	Invalid parameter

Design a Mobile Website

View Site in Mobile | Classic