IG User

Represents an Instagram Business Account or an Instagram Creator Account.

Throughout our documentation we use "Instagram User" and "Instagam Account" interchangeably. Both represent your app user's Instagram professional account.

Requirements

	Instagram API with Instagram Login	Instagram API with Facebook Login
Access Tokens	Instagram User user access token	Facebook User access token
Host URL	`graph.instagram.com`	`graph.facebook.com`
Login Type	Business Login for Instagram	Facebook Login for Business
Permissions	`instagram_business_basic`	`instagram_basic` `pages_read_engagement` If the app user was granted a role via the Business Manager on the Page connected to the targeted IG User, you will also need one of: `ads_management` `ads_read` If you are requesting the `shopping_product_tag_eligibility` field for product tagging, you will also need: `catalog_management` `instagram_shopping_tag_products`
Business Roles	Not applicable.	If you are requesting the `shopping_product_tag_eligibility` field for product tagging, the app user must have an admin role on the Business Manager that owns the IG User's Instagram Shop.
Instagram Shop	Not applicable.	If you are requesting the `shopping_product_tag_eligibility` field for product tagging, the IG User must have an approved Instagram Shop with a product catalog containing products.

Creating

This operation is not supported.

Reading

GET /<IG_USER_ID>

Get fields and edges on an Instagram Business or Creator Account.

If you are migrating from Marketing API Instagram Ads endpoints to Instagram Platform endpoints, be aware that some field names are different.

Request Syntax

GET https://graph.facebook.com/<API_VERSION>/<IG_USER_ID>
  ?fields=<LIST_OF_FIELDS>
  &access_token=<ACCESS_TOKEN>

Path Parameters

Placeholder	Value
`<API_VERSION>`	API version.
`<IG_USER_ID>`	Required. IG User ID.

Query String Parameters

Key	Placeholder	Value
`access_token`	`<ACCESS_TOKEN>`	Required. App user's User access token.
`fields`	`<LIST_OF_FIELDS>`	Comma-separated list of IG User fields you want returned for each IG User in the result set.

Fields

Public fields can be returned by an edge using field expansion.

Field Name	Description
`alt_text` Public	Descriptive text for images, for accessibility.
`biography` Public	Profile bio text.
`followers_count` Public	Total number of Instagram users following the user.
`follows_count`	Total number of Instagram users the user follows.
`has_profile_pic`	Indicates whether your app user's Instagram professional account has a profile picture.
`id` Public	App-scoped User ID.
`is_published`	Indicates whether your app user's Instagram account is published
`legacy_instagram_user_id`	Your app user's Instagram ID that was created for Marketing API endpoints for v21.0 and older.
`media_count` Public	Total number of IG Media published on your app user's account.
`name`	Your app user's Instagram profile name.
`profile_picture_url`	Your app user's Instagram profile picture URL.
`shopping_product_tag_eligibility`	Returns `true` if your app user has set up an Instagram Shop and is therefore eligible for product tagging, otherwise returns `false`.
`username` Public	Your app user's Instagram profile username.
`website` Public	Your app user's website URL.

Edges

Edge	Description
`agencies`	A list of businesses that can advertize for this Instagram professional account.
`authorized_adaccounts`	Ad accounts that can advertize for this Instagram professional account.
`business_discovery`	Get data about other Instagram Business or Instagram Creator IG Users.
`content_publishing_limit`	Represents an IG User's current content publishing usage.
`insights`	Represents social interaction metrics on an IG User.
`live_media`	Represents a collection of live video IG Media on an IG User.
`media`	Represents a collection of IG Media on an IG User.
`media_publish`	Publish an IG Container on an Instagram Business IG User.
`mentions`	Create an IG Comment on an IG Comment or captioned IG Media that an IG User has been @mentioned in by another Instagram user.
`mentioned_comment`	Get data on an IG Comment in which an IG User has been @mentioned by another Instagram user.
`mentioned_media`	Get data on an IG Media in which an IG User has been @mentioned in a caption by another Instagram user.
`recently_searched_hashtags`	Get IG Hashtags that an IG User has searched for within the last 7 days.
`stories`	Represents a collection of story IG Media objects on an IG User.
`tags`	Represents a collection of IG Media in which an IG User has been tagged by another Instagram user.
`upcoming_events`	A list of events this Instagram professional account is hosting.

Response

A JSON-formatted object containing default and requested fields and edges.

{
  "<FIELD>":"<VALUE>",
  ...
}

cURL Example

Request

curl -X GET \
  'https://graph.facebook.com/v22.0/17841405822304914?fields=biography%2Cid%2Cusername%2Cwebsite&access_token=EAACwX...'

Response

{
  "biography": "Dino data crunching app",
  "id": "17841405822304914",
  "username": "metricsaurus",
  "website": "http://www.metricsaurus.com/"
}

Updating

This operation is not supported.

Deleting

This operation is not supported.