Search
K
Yuki Platform API Prod

Get domain by ID

Retrieves detailed information about a specific domain using its unique identifier. This includes domain metadata, associated companies, and configuration details. You should have yukiapi:domain:domains:read scope to access this endpoint.

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

Path Parameters

portal-idstringrequired

The portal id

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

domain-idstringrequired

The domain name

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

Domain object

GetDomain

domainIdstring

The unique identifier of the domain.

Example:550e8400-e29b-41d4-a716-446655440000

domainNamestring

The name of the domain.

Example:my-company-domain

domainStatusstring

The status of the domain.

Allowed values:StartupActiveArchivedInactiveRemovedPermanentlyDeleted

Example:Active

domainBundlestring

The bundle type for the domain.

Allowed values:MinimalSmallMediumLargeUnlimited

Example:Medium

companiesarray[object]

List of companies associated with the domain.

Show Child Parameters
backOfficeobject

Back office configuration settings.

Show Child Parameters
  
curl --request GET \
  --url https://apirest.yukiworks.com/api/v1/portals/3afb7b54-6144-4561-9a29-1148006f2375/domains/3afb7b54-6144-4561-9a29-1148006f2375 \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json'
application/json
{
  "domainId": "550e8400-e29b-41d4-a716-446655440000",
  "domainName": "my-company-domain",
  "domainStatus": "Active",
  "domainBundle": "Medium",
  "companies": [
    {
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "companyName": "Acme Corporation"
    }
  ],
  "backOffice": {
    "access": "AllEmployees",
    "responsible": "user123",
    "backup": "user456",
    "controller": "user789",
    "accountManager": "user012"
  }
}