Get information about a relationship to another user.

GET

/users/{user-id}/relationship

relationships

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.instagram.com/v1/users//relationship'

Response Example

{
  "data": {
    "incoming_status": "none",
    "outgoing_status": "none",
    "target_user_is_private": true
  },
  "meta": {
    "code": 0
  }
}

Request

Path Params

user-id

string

required

The ID of a user to get information about.

🟢200Relationship information.

application/json

Body

data

object (RelationshipInfo)

optional

incoming_status

enum<string>

optional

Status of incoming relationship

Allowed values:

nonefollowed_byrequested_by

outgoing_status

enum<string>

optional

Status of outgoing relationship

Allowed values:

nonefollowsrequested

target_user_is_private

boolean

optional

Indicates whether target user is private or not