offsetinteger
The number of items to skip before starting to collect the result set
limitinteger
The numbers of items to return
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
Query Parameters
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
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
offsetinteger
Current offset in the list
Example:10
limitinteger
Maximum number of items returned
Example:20
itemsarray[object]
Show Child Parameters
curl --request GET \
--url https://apirest.yukiworks.com/api/v1/portals/3afb7b54-6144-4561-9a29-1148006f2375/users \
--header 'Accept: application/json, application/problem+json' \
--header 'Content-Type: application/json' application/json
{
"totalItems": 100,
"offset": 10,
"limit": 20,
"items": [
{
"id": "3afb7b54-6144-4561-9a29-1148006f2375",
"name": "John Doe",
"email": "john.doe@yuki.nl",
"language": "en-US",
"roles": [
"PortalAdministrator"
]
}
]
}