Marketing API Version

Clients

Provides operations to create, read, update and delete Clients.

Read Clients

Permissions

A user access token with Atlas API capability is required to request client details.

Fields

Reading this endpoint returns a single or an array of Client objects with the same fields as the node.

Read Client

You can get details of the client by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<CLIENT_ID>

Response:

{
  "branch_id": "11002200631600", 
  "created_date": "2013-11-04T20:15:11+0000", 
  "id": "11002200631300",
  "last_modified_date": "2013-11-04T20:15:11+0000", 
  "name": "Test Client", 
  "version": "1"
}

Curl Example:

A curl example to get client details:

curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<CLIENT_ID>

Read Branch Client

You can get details of the clients for a branch by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<BRANCH_ID>/clients

Response:

{
  "data": [
    {
      "branch_id": "11002200631600",
      "created_date": "2013-11-04T12:15:11-08:00", 
      "id": "11002200631300",
      "last_modified_date": "2013-11-04T12:15:11-08:00", 
      "name": "Test Client",
      "version": "1"
    }
  ]
}

Curl Example:

A curl example to get client details for a branch:

curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<BRANCH_ID>/clients

Read Company Client

You can get details of the clients for a company by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<COMPANY_ID>/clients

Response:

{
  "data": [
    {
      "branch_id": "11002200631600",
      "created_date": "2013-11-04T12:15:11-08:00", 
      "id": "11002200631300",
      "last_modified_date": "2013-11-04T12:15:11-08:00", 
      "name": "Test Client",
      "version": "1"
    }
  ]
}

Curl Example:

A curl example to get client details for a company:

curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<COMPANY_ID>/clients

Connections or Related Endpoints of Clients (Edges)

NameDescription

/advertisers

Advertisers associated with the client