Search
K
Yuki Platform API Prod

Get Portal info

This endpoint retrieves information about a portal using its unique portal ID. Ensure you have the necessary permissions before accessing this endpoint. You should have the openid and yukiapi:portal:portals:read scopes to access this endpoint. Returns portals:not_found (404) if no portal has that id.

Authorization

Called with a Portal User token - an employee of an accounting portal.

The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.

get
https://apirest.yukiworks.be/api/v1/portals/{portal-id}

Path Parameters

portal-idstringrequired

The portal id

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

Headers

Authorizationstringrequired

Bearer token for authentication

Response

application/json

Portal object

Portal

idstring

The unique ID of the Portal

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

namestring

Name of the Portal

Example:Example Portal

countrystring

Country of the Portal in ISO-3166 (2 char) format

contactobject | null

Contact person of the Portal. Null when no contact person is linked to the Portal

Show Child Parameters
subPortalsarray[object]

The Portal’s direct (1st generation) child portals

Show Child Parameters
 
application/json

Portal User

Operations related to portal users

Get All Portal Users

This endpoint retrieves basic information about users by Portal id. You should have the openid and yukiapi:portal:users:read scopes to access this endpoint.

Authorization

Called with a Portal User token - an employee of an accounting portal.

The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.

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

Query Parameters

offsetinteger

Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400.

Default:0

>= 0

limitinteger

Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400.

Default:20

>= 1<= 500

Path Parameters

portal-idstringrequired

The portal id

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

Headers

Authorizationstringrequired

Bearer token for authentication

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
 
application/json

Create Portal User

This endpoint allows the creation of a user in the portal. Ensure the user has the necessary permissions before attempting to create a user. You should have the openid and yukiapi:portal:users:write scopes to access this endpoint. Returns portals:user_already_exists (409) if that address is already a user of this portal, or portals:validation_failed (400) if the portal refuses the user for another reason.

Authorization

Called with a Portal User token - an employee of an accounting portal.

The caller must hold the AccountantManagement role in the portal.

post
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/users

Path Parameters

portal-idstringrequired

The portal id

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

Headers

Authorizationstringrequired

Bearer token for authentication

Body

application/json

CreatePortalUser

firstNamestringrequired

First name of the user

lastNamestringrequired

Last name of the user

emailstring(email)required

User email

Example:john.doe@yuki.nl

languagestringrequired

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

rolestringrequired

Role of the user

Allowed values:PortalAdministratorPortalBackofficePortalDataEntry

messagestring

User message

Response

application/json

Portal user created successfully

idstring

The ID of the created user

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

 
application/json

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 the openid and yukiapi:portal:users:read scopes to access this endpoint. Returns portals:user_not_found (404) if no user in this portal carries that address.

Authorization

Called with a Portal User token - an employee of an accounting portal.

The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.

get
https://apirest.yukiworks.be/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

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

languageAny Of

The user’s locale. Empty string when the stored value has no ISO mapping (e.g. the user never chose a language).

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

 
application/json