Skip to main content

Read Users

POST /users/fetch​

Getting users' information by user IDs in bulk.

info

This API will only return the list of existing users, and ignore those that do not exist.

Endpoint URL

 https://api.mixin.one/users/fetch

Authentication and options

Authorization
PROFILE:READ; If the `PHONE:READ` permission granted, you will obtain the user's mobile phone number
LimitationNo limitation

Payload

[
  // array of user_id
  "UUID",
  "UUID",
  "UUID",
]

Example request

curl -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" https://api.mixin.one/users/fetch --data '["06aed1e3-bd77-4a59-991a-5bb5ae6fbb09"]'
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
    },
    ...
  ]
}