Pull API \ Retrieve the Facebook groups a user is member of

Resource/URI GET
Facebook · Retrieve a user's likes /pull/identities/<identity_token>/facebook/likes.json Retrieve Likes
Facebook · Retrieve a user's posts /pull/identities/<identity_token>/facebook/posts.json Retrieve Posts
Facebook · Retrieve a user's groups /pull/identities/<identity_token>/facebook/groups.json Retrieve Groups
Facebook · Retrieve a user's group posts /pull/identities/<identity_token>/facebook/group/<pageid>/posts.json Retrieve Group Posts
Facebook · Retrieve a user's pages /pull/identities/<identity_token>/facebook/pages.json Retrieve Pages
Facebook · Retrieve a user's page posts /pull/identities/<identity_token>/facebook/page/<pageid>/posts.json Retrieve Page Posts
Facebook · Retrieve a user's page post reactions /pull/identities/<identity_token>/facebook/page/<pageid>/posts.json Retrieve Page Post Reactions
LinkedIn · Retrieve a user's companies /pull/identities/<identity_token>/linkedin/companies.json Retrieve Companies
LinkedIn · Retrieve a user's company posts /pull/identities/<identity_token>/linkedin/company/<companyid>/posts.json Retrieve Company Posts
Pinterest · Retrieve a user's boards /pull/identities/<identity_token>/pinterest/boards.json Retrieve Boards
Pinterest · Retrieve a user's board pins /pull/identities/<identity_token>/pinterest/board/<boardid>/pins.json Retrieve Board Pins
Pinterest · Retrieve a user's pins /pull/identities/<identity_token>/pinterest/pins.json Retrieve Pins
Steam · Retrieve a user's games /pull/identities/<identity_token>/steam/games.json Retrieve Games
Twitter · Retrieve a user's followers /pull/identities/<identity_token>/twitter/followers.json Retrieve Followers
Twitter · Retrieve a user's followings /pull/identities/<identity_token>/twitter/followings.json Retrieve Followings
Twitter · Retrieve a user's tweets /pull/identities/<identity_token>/twitter/tweets.json Retrieve Tweets
Twitter · Retrieve a user /pull/identities/<identity_token>/twitter/user.json Retrieve User
YouTube · Retrieve a user's channels /pull/identities/<identity_token>/youtube/channels.json Retrieve Channels
YouTube · Retrieve a user's playlists /pull/identities/<identity_token>/youtube/playlists.json Retrieve Playlists
YouTube · Retrieve a user's playlist videos /pull/identities/<identity_token>/youtube/playlist/<playlistid>/videos.json Retrieve Playlist Videos
YouTube · Retrieve a user's channel sections /pull/identities/<identity_token>/youtube/channel/sections.json Retrieve Channel Sections

Workflow

Request: the code to send to the API

Send an API request to the following endpoint in order to retrieve all groups a Facebook user is member of:

GET /pull/identities/<identity_token>/facebook/groups.json

The <identity_token> is obtained whenever one of your users connects using Facebook. The following URL parameters can optionally be used with this endpoint:

URL Parameter Description
num_groups
integer
Indicates how many groups should be included in the resultset. The valid range is between 1 an 200.
Default: 25
page
integer
Indicates the page that should be retrieved. To paginate the resultset, simply start with page 1 and make subsequent requests to this endpoint while incrementing the page number with each call.
Default: 1
limit_admin_groups
boolean
Per default all groups the user is a member of are returned. Set this value to true in order to retrieve only groups the user administers.
Default: false

In order to use this endpoint the permission Publish To Group must be enabled in the Facebook settings in your OneAll account and the user must have granted this permission when he logged in with Facebook. You can use our Pull API to retrieve the groups of an identity.

Result: the code returned by the API

Response Example

{
  "response": {
    "request": {
      "date": "Mon, 04 May 2020 11:02:08  0200",
      "resource": "/pull/identities/azd41dc99df-151z-459f-a90b-123ad791ab12/facebook/groups.json?num_groups=2&after=QVFIUjJsUHN3dXViY2lJLWFHSXdxVzFDdU5EWGhyS25MbFFRZAHFsOFBHb0NNM25HVmJ4aS1vdUkzQWRBRk1SVmFmM1pfeElMVGVDR0xMRFRYMlBfRk5wZAktB",
      "status": {
        "flag": "success",
        "code": 200,
        "info": "Your request has been processed successfully"
      }
    },
    "result": {
      "data": {
        "count": 2,
        "entries": [
          {
            "id" : "868207289892665",
            "name" : "Street Triple & Daytona",
            "description" : "Group of Triumph Owners",
            "cover" : "https://scontent-cdg2-1.xx.fbcdn.net/v/t1.0-9/s720x720/35543424_10216483609633483_8992247739144208384_o.jpg?_nc_cat=100&_nc_sid=ca434c&_nc_ohc=mTLt1rDHo98AX-wOxdQ&_nc_ht=scontent-cdg2-1.xx&_nc_tp=7&oh=2f36c1fa02e9cda3278251209fbeb004&oe=5ED7822D",
            "email" : "868207289892665@groups.facebook.com",
            "created_time" : "2015-03-27T21:31:14+0000"
          },
          {
            "id" : "145437213572676",
            "name" : "Test group",
            "email" : "145437213572676@groups.facebook.com",
            "created_time" : "2020-04-03T08:07:34+0000",
            "member_count" : "1",
            "privacy" : "OPEN"
          }
        ]
      }
    }
  }
}

User Contributed Notes