portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Get All Portal Users
This endpoint retrieves basic information about users by Portal id. You should have yukiapi:portal:users:read scope to access this endpoint.
get
https://apirest.yukiworks.com/api/v1/portals/{portal-id}/users
Path Parameters
Headers
Authorizationstringrequired
Bearer token for authentication
Content-Typestringrequired
Content type, must be application/json
Allowed values:application/json
Response
application/json
Response
application/json
Paged result of portal users
totalItemsinteger
Total number of items available
Example:100
currentOffsetinteger
Current offset in the list
Example:10
limitinteger
Maximum number of items returned
Example:20
itemsarray[object]
Show Child Parameters
application/json