Search
K
Yuki Platform API Prod

Search Portal Users

This endpoint allows searching for users within a specific portal by email address. Returns the user details if a match is found. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have yukiapi:portal:users:read scope to access this endpoint.

get
https://apirest.yukiworks.com/api/v1/portals/{portal-id}/users/search

Query Parameters

emailstring(email)required

Email address to search for

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

Portal user object

PortalUser

idstring

The user’s ID

Example:3afb7b54-6144-4561-9a29-1148006f2375

namestring

Full name of the user

Example:John Doe

emailstring(email)

User email

Example:john.doe@yuki.nl

languagestring

The locale for the domain.
BE: nl-BE, en-US, fr-BE.
NL: en-US, nl-NL

Allowed values:nl-BEen-USfr-BEnl-NL

Example:en-US

rolesarray[string]

User roles for portal users

Allowed values:PortalAdministratorPortalBackofficePortalBackofficeControllerPortalDataEntry

  
curl --request GET \
  --url 'https://apirest.yukiworks.com/api/v1/portals/3afb7b54-6144-4561-9a29-1148006f2375/users/search?email=' \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json'
application/json
{
  "id": "3afb7b54-6144-4561-9a29-1148006f2375",
  "name": "John Doe",
  "email": "john.doe@yuki.nl",
  "language": "en-US",
  "roles": [
    "PortalAdministrator"
  ]
}