Sign in
latestOpenAPI 3.0.02026-08-10135177718.4 KB

f739db716aaf

Relationships

Search relationships for the authenticated user

get/relationships

Query parameters

qstring
user_idinteger

Related user must have this ID

trusted'yes' | 'no' | 'any'

Whether or not the user trusts the friend with hidden coordinates.

following'yes' | 'no' | 'any'

Whether or not the user wants to see updates about new content from the friend.

order'desc' | 'asc'
order_by'friendships.id' | 'users.login'
{"stackTrail":"paths:/relationships:get:parameters:7:schema","oasType":"schema","type":"unknown"}

Attribute fields to return in the response

Headers

X-HTTP-Method-Overridestring

Response

A list of relationships

total_resultsinteger required
pageinteger required
per_pageinteger required

Example response

{
  "results": [
    {
      "user": {
        "site": {
          "id": 1,
          "icon_url": "https://static.inaturalist.org/sites/1-logo_square.png",
          "locale": "en",
          "name": "iNaturalist",
          "site_name_short": "iNat",
          "url": "https://www.inaturalist.org"
        }
      },
      "friend_user": {
        "site": {
          "id": 1,
          "icon_url": "https://static.inaturalist.org/sites/1-logo_square.png",
          "locale": "en",
          "name": "iNaturalist",
          "site_name_short": "iNat",
          "url": "https://www.inaturalist.org"
        }
      }
    }
  ]
}