emailstring(email)required
Email address to search for
Delete Domain User
This endpoint allows deleting a user from a specific domain by email. Users attempting to perform this operation need to ensure they possess the necessary permissions. Once deleted, the user information cannot be recovered. You should have the openid and yukiapi:domain:users:delete scopes to access this endpoint. Returns domains:user_not_found (404) if no user on this domain 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.
delete
https://apirest.yukiworks.be/api/v1/domains/{domain-id}/users/byEmail
Query Parameters
Path Parameters
domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Response
Response
Domain user successfully deleted
Portal
Operations related to portals
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
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
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