Skip to main content
GET
/
v2
/
access
/
users
/
lists
/
:listId
Get user list
curl --request GET \
  --url https://api-next.ofauth.com/v2/access/users/lists/:listId \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "id": "<string>",
  "type": "<string>",
  "name": "<string>",
  "sortList": [
    {
      "order": "<string>",
      "direction": "<string>"
    }
  ],
  "users": [
    {
      "id": 123,
      "username": "<string>",
      "name": "<string>",
      "isVerified": true,
      "avatar": "<string>",
      "avatarThumbs": {
        "c50": "<string>",
        "c144": "<string>"
      }
    }
  ],
  "usersCount": 123,
  "postsCount": 123,
  "order": "<string>",
  "direction": "<string>",
  "canUpdate": true,
  "canDelete": true,
  "canManageUsers": true,
  "canAddUsers": true,
  "canPinnedToFeed": true,
  "isPinnedToFeed": true,
  "canPinnedToChat": true,
  "isPinnedToChat": true
}

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Path Parameters

listId
string
required

Response

Successful response

id
required
type
string
required
name
string
required
sortList
object[]
required
users
object[]
required
usersCount
number
postsCount
number
order
string
direction
string
canUpdate
boolean
canDelete
boolean
canManageUsers
boolean
canAddUsers
boolean
canPinnedToFeed
boolean
isPinnedToFeed
boolean
canPinnedToChat
boolean
isPinnedToChat
boolean