---
title: "Get list of all online friends for the specified user."
method: GET
path: "/v1/users/{userId}/friends/online"
tags: ["Connections", "Users"]
---

# Get list of all online friends for the specified user.

`GET /v1/users/{userId}/friends/online`

## Path parameters

- `userId` integer, required

## Query parameters

- `userSort` 0 | 1 | 2

## Response `200`

OK

- RobloxWebWebAPIModelsApiArrayResponseRobloxFriendsApiModelsResponseUserPresenceResponse
  - `data` RobloxFriendsApiModelsResponseUserPresenceResponse[]
    - `userPresence` RobloxFriendsApiModelsResponseUserPresenceResponseModel — Response model for !:IUserPresence objects
      - `UserPresenceType` string — User Presence Type
      - `UserLocationType` string — Location Type
      - `lastLocation` string — Last Location
      - `placeId` integer — Place Id
      - `rootPlaceId` integer — Root Place Id
      - `gameInstanceId` string, uuid — Game Instance Id
      - `universeId` integer — Universe Id
      - `lastOnline` string, date-time — Most recent time online
    - `sortScore` number, double — Carousel sort score
    - `id` integer — The user Id.
    - `name` string — The user name.
    - `displayName` string — The user DisplayName.

## Other responses

- `400` — 1: The target user is invalid or does not exist. 6: Invalid parameters.
- `401` — 0: Authorization has been denied for this request.

---

[API](https://skmtc.net/roblox/apis/roblox-api.md) · [All operations](https://skmtc.net/roblox/apis/roblox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roblox/roblox-api/revisions/9e4acc812347/schema)
