Skip to main content

Read Contacts

GET /friends​

Obtaining the contact list of the user.

The list contains users and bots. You can judge whether it is a bot user by whether there is an app field.

Endpoint URL

 https://api.mixin.one/friends

Authentication and options

Authorization
CONTACTS:READ
LimitationNo limitation

Example request

curl -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" https://api.mixin.one/friends
Response
{
  "data": [
    {
      "type":             "user",
      "user_id":          "773e5e77-4107-45c2-b648-8fc722ed77f5",
      "identity_number":  "7000",
      "phone":            "+8613801380138",
      "full_name":        "Team Mixin",
      "biography":        "",
      "avatar_url":       "https://images.mixin.one/E2y0BnTopFK9qey0YI-8xV3M82kudNnTaGw0U5SU065864SsewNUo6fe9kDF1HIzVYhXqzws4lBZnLj1lPsjk-0=s256",
      "relationship":     "STRANGER",
      "mute_until":       "0001-01-01T00:00:00Z",
      "created_at":       "2017-12-23T18:23:26.996149Z",
      "is_verified":      true
    },
    ...
  ]
}