Search
K
Yuki Platform API Prod

Get All Domains for a Portal

This endpoint allows the retrieval of all domains belonging to a Portal. Ensure you have the necessary permissions before attempting to retrieve the domains list. You should have yukiapi:portal:portals:read and yukiapi:domain:domains:read scopes to access this endpoint.

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

Query Parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

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

Paged result of domains

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/domains \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json'
application/json
{
  "totalItems": 100,
  "offset": 10,
  "limit": 20,
  "items": [
    {
      "id": "e7ff8d6e-d82a-4649-be6e-523db02052d3",
      "name": "Example Domain",
      "hid": "abcd1234",
      "type": "Business",
      "status": "Active",
      "country": "Netherlands",
      "owner": {
        "name": "John Doe",
        "email": "john.doe@yuki.nl"
      },
      "backoffice": {
        "blocked": false,
        "selfAccountingActive": true,
        "message": "All systems operation",
        "responsible": {
          "id": "user1",
          "name": "JaneSmith"
        },
        "backupResponsible": {
          "id": "user1",
          "name": "JaneSmith"
        },
        "controller": {
          "id": "user1",
          "name": "JaneSmith"
        },
        "accountManager": {
          "id": "user1",
          "name": "JaneSmith"
        }
      },
      "comments": "No additional comments.",
      "createdDate": "2023-01-01T10:00:00Z",
      "createdBy": "Admin User",
      "modifiedDate": "2023-01-15T15:30:00Z",
      "modifiedBy": "Moderator",
      "lastUserLogin": "2023-01-20T09:00:00Z",
      "lastDocumentUpload": "2023-01-18T14:45:00Z",
      "contract": {
        "bundle": "Premium",
        "startDate": "2023-01-01",
        "endDate": "2024-01-01"
      }
    }
  ]
}