Skip to main content
GET
/
v2
/
access
/
users
/
lists
List user lists
curl --request GET \
  --url https://api.ofauth.com/v2/access/users/lists \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "list": [
    {
      "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
    }
  ],
  "hasMore": true,
  "order": "<string>",
  "sort": "<string>"
}

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.

Query Parameters

​
limit
integer
default:10

Number of items to return (1-100, default: 10)

Required range: 1 <= x <= 100
​
offset
integer | null
default:0

Number of items to skip (default: 0)

Required range: x >= 0
​
query
string

Search/filter text

Maximum string length: 100
​
related_user
string

Only return lists related to this user

Minimum string length: 1

Response

Successful response

​
list
object[]
required
​
hasMore
boolean
required
​
order
string
​
sort
string