Skip to main content
GET
/
relations
/
list
List all relations for a resource and/or a user or none
curl --request GET \
  --url https://api.example.com/relations/list
{
  "data": [
    {
      "id": "<string>",
      "userId": "<string>",
      "resourceId": "<string>",
      "relationType": "<string>"
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Query Parameters

count
number
default:10

the number of items to return

page
number
default:1

the page to retrieve

userId
string
resourceId
string
resourceIds
string[]
types
string[]

Response

200 - application/json
data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages