Share via

Organizational Page Follows API

  • Article

Try in Postman

The Organizational Page Follows API retrieves follow-related information of members as well as other organizational pages of an organizational page.

The service provides the following methods:

  • Finder followee retrieves followers for the provided followee with an optional filter to include only member or organizational page followers.
  • Finder follower retrieves all the organizational pages that the provided follower follows.

The finders for this API utilize the Pagination Cursor and Max Pagination Count pattern for pagination.

Please note the following restrictions of the API:

  1. The value of the maxPaginationCount parameter cannot exceed 1000 for any single request.
  2. Data returned by this API can be up to 48 hours delayed.
  3. This API has a rate limit of 1 request per 60 seconds. An error will be returned if this rate limit is exceeded.
  4. The latency for certain requests might at times exceed 10 seconds. If a timeout is experienced, wait 60 seconds then retry calling the API. Most requests should however have a significant lower latency.

Permissions

Permission Description
r_dma_admin_pages_content Retrieve your organization's posts, comments, reactions, and other engagement data. Retrieve your organization's pages and their reporting data (including follower, visitor, and content analytics). Restricted to organizations in which the authenticated member has one of the following company page roles.
  • ADMINISTRATOR
  • DIRECT_SPONSORED_CONTENT_POSTER
  • RECRUITING_POSTER

See Organization Access Control for more information on company page roles.

Member Data Obfuscation

This DMA API has member data that is obfuscated.

Field Description
follower The urn of the entity that's the follower. This field is only obfuscated if the follower is a member and has not granted permission to share their data via DMA API.

Schema

Field Format Description Required
follower URN The urn of the entity that's the follower. It can be an organizational page urn with format urn:li:organizationalPage:{ID} or a person urn with the format urn:li:person:{ID}. No
followee OrganizationalPageUrn The urn of the entity that is the followee. It is of type urn:li:organizationalPage:{ID}. Yes
edgeType OrganizationalPageFollowEdgeType Type of edge to specify what type of follower to retrieve. Value enums include:
  • MEMBER_FOLLOWS_ORGANIZATIONAL_PAGE
  • ORGANIZATIONAL_PAGE_FOLLOWS_ORGANIZATIONAL_PAGE
 Yes
lastModifiedAt long Last modified time of the edge. No

Retrieve Organizational Page Follows Data

Finder Followee

Sample Request

GET https://api.linkedin.com/rest/dmaOrganizationalPageFollows?q=followee&followee={FOLLOWEE_URN}&edgeType=ORGANIZATIONAL_PAGE_FOLLOWS_ORGANIZATIONAL_PAGE&maxPaginationCount=5

Sample Response

{
  "paging": {
    "start": 0,
    "count": 10,
    "links": [],
    "total": 2
  },
  "metadata": {
    "nextPaginationCursor": "NV9f"
  },
  "elements": [
    {
      "lastModifiedAt": 1701259792468,
      "follower": "urn:li:person:WIOb",
      "followee": "urn:li:organizationalPage:123456",
      "edgeType": "MEMBER_FOLLOWS_ORGANIZATIONAL_PAGE"
    },
    {
      "lastModifiedAt": 1699980274432,
      "follower": "urn:li:person:szIhq",
      "followee": "urn:li:organizationalPage:123456",
      "edgeType": "MEMBER_FOLLOWS_ORGANIZATIONAL_PAGE"
    }
  ]
}

Parameters

Field Name Format Description Required Example
q String Name of the finder function to retrieve data from. Finder name: followee. Yes q=followee
followee OrganizationalPageUrn The urn of organizational page entity being followed. It is of type urn:li:organizationalPage:{ID}. Yes followee=urn%3Ali%3AorganizationalPage%3A123456
edgeType OrganizationalPageFollowEdgeType Type of edge to specify what type of follower to retrieve. Value enums include:
  • MEMBER_FOLLOWS_ORGANIZATIONAL_PAGE
  • ORGANIZATIONAL_PAGE_FOLLOWS_ORGANIZATIONAL_PAGE
 Yes edgeType=MEMBER_FOLLOWS_ORGANIZATIONAL_PAGE
maxPaginationCount Integer The pagination count to apply. Yes maxPaginationCount=5
paginationCursor String The optional pagination cursor to apply. If no cursor is passed the first page will be returned. No paginationCursor=NSYtMQ

Finder Follower

Sample Request

GET https://api.linkedin.com/rest/dmaOrganizationalPageFollows?q=follower&follower={FOLLOWER_URN}&maxPaginationCount=5

Sample Response

{
  "paging": {
    "start": 0,
    "count": 10,
    "links": [],
    "total": 2
  },
  "metadata": {},
  "elements": [
    {
      "lastModifiedAt": 1697133365784,
      "follower": "urn:li:organizationalPage:123456",
      "followee": "urn:li:organizationalPage:1122334",
      "edgeType": "ORGANIZATIONAL_PAGE_FOLLOWS_ORGANIZATIONAL_PAGE"
    },
    {
      "lastModifiedAt": 1697133365063,
      "follower": "urn:li:organizationalPage:123456",
      "followee": "urn:li:organizationalPage:223344",
      "edgeType": "ORGANIZATIONAL_PAGE_FOLLOWS_ORGANIZATIONAL_PAGE"
    }
  ]
}

Parameters

Field Name Format Description Required Example
q String Name of the finder function to retrieve data from. Finder name: follower. Yes q=follower
follower URN The urn of the entity that is following an organizational page. It can be a person urn with format urn:li:person:{ID} or an organizational page urn with format urn:li:organizationalPage:{ID}. Yes follower=urn%3Ali%3AorganizationalPage%3A123456
maxPaginationCount Integer The pagination count to apply. Yes maxPaginationCount=5
paginationCursor String The optional pagination cursor to apply. If no cursor is passed in the first page will be returned. No paginationCursor=NSYtMQ

API Error Details

HTTP Status Code ERROR MESSAGE DESCRIPTION ERROR RESOLUTION
400 BAD_REQUEST Invalid request. Please verify the API input. Use a valid URL and parameters.
401 EMPTY_ACCESS_TOKEN Empty or expired OAuth2 access token. Use a valid member access token.
403 FORBIDDEN Accessing to the resource is forbidden. Please check your permissions for this resource. Make sure your developer application is provisioned with the required permissions.
404 NOT_FOUND Could not find entity. Verify the provided entity ID is correct.
500 INTERNAL_SERVER_ERROR Server encountered an unexpected condition that prevented it from fulfilling the request. N/A