Marketing API Version

Branches

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

Read Branches

Permissions

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

Fields

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

Read Branch

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

An example of the request and response:

Request:

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

Response:

{
  "company_id": "11002200631700", 
  "created_date": "2013-11-04T20:15:11+0000", 
  "id": "11002200631600",  
  "last_modified_date": "2013-11-04T20:15:11+0000", 
  "name": "Test Branch", 
  "version": "1"
}

Curl Example:

A curl example to get branch details:

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

Read Company Branch

You can get details of the branches 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>/branches

Response:

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

Curl Example:

A curl example to get branch details for a company:

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

Connections or Related Endpoints of AtlasBranches (Edges)

NameDescription

/clients

Clients associated with the branch